Type Aliases Access Control Policy Access
Control
Policy
: MetadataWithContent & { active
: boolean ; deploymentStatus
: string ; description
?: string | null ; masterLabel
: string ; targetEntity
: string ; version
: number } Access Mapping Access Mapping: { accessLevel: string ; object: string ; objectField: string ; userField: string }
Type declaration access Level: string object: string object Field: string user Field: string Account Relationship Share Rule Account
Relationship
Share
Rule
: Metadata & { accessLevel
: string ; accountToCriteriaField
: string ; description
?: string | null ; entityType
: string ; masterLabel
: string ; staticFormulaCriteria
?: string | null ; type
: string } Account Settings Account
Settings
: Metadata & { enableAccountHistoryTracking
?: boolean | null ; enableAccountInsightsInMobile
?: boolean | null ; enableAccountOwnerReport
?: boolean | null ; enableAccountTeams
?: boolean | null ; enableContactHistoryTracking
?: boolean | null ; enableRelateContactToMultipleAccounts
?: boolean | null ; showViewHierarchyLink
?: boolean | null } Account Sharing Rule Settings Account Sharing Rule Settings: { caseAccessLevel: string ; contactAccessLevel: string ; opportunityAccessLevel: string }
Type declaration case Access Level: string contact Access Level: string opportunity Access Level: string Action Link Group Template Action
Link
Group
Template
: Metadata & { actionLinkTemplates
: ActionLinkTemplate [] ; category
: string ; executionsAllowed
: string ; hoursUntilExpiration
?: number | null ; isPublished
: boolean ; name
: string } Action Link Template Action Link Template: { actionUrl: string ; headers?: string | null ; isConfirmationRequired: boolean ; isGroupDefault: boolean ; label?: string | null ; labelKey: string ; linkType: string ; method: string ; position: number ; requestBody?: string | null ; userAlias?: string | null ; userVisibility: string }
Type declaration action Url: string Optional headers?: string | null is Confirmation Required: boolean is Group Default: boolean Optional label?: string | null label Key: string link Type: string method: string position: number Optional request Body?: string | null Optional user Alias?: string | null user Visibility: string Action Override Action Override: { actionName?: string | null ; comment?: string | null ; content?: string | null ; formFactor?: string | null ; skipRecordTypeSelect?: boolean | null ; type?: string | null }
Type declaration Optional action Name?: string | null Optional comment?: string | null Optional content?: string | null Optional form Factor?: string | null Optional skip Record Type Select?: boolean | null Optional type?: string | null Action Plan Template Action
Plan
Template
: Metadata & { actionPlanTemplateItem
: ActionPlanTemplateItem [] ; description
?: string | null ; name
: string ; targetEntityType
: string ; uniqueName
: string } Action Plan Template Item Action
Plan
Template
Item
: { actionPlanTemplateItemValue
: ActionPlanTemplateItemValue [] ; displayOrder
?: number | null ; isRequired
?: boolean | null ; name
: string ; uniqueName
: string } Type declaration Optional display Order?: number | null Optional is Required?: boolean | null name: string unique Name: string Action Plan Template Item Value Action Plan Template Item Value: { name: string ; valueFormula?: string | null ; valueLiteral?: string | null }
Type declaration name: string Optional value Formula?: string | null Optional value Literal?: string | null Actions Settings Actions
Settings
: Metadata & { enableDefaultQuickActionsOn
?: boolean | null ; enableMdpEnabled
?: boolean | null ; enableThirdPartyActions
?: boolean | null } Activities Settings Activities
Settings
: Metadata & { allowUsersToRelateMultipleContactsToTasksAndEvents
?: boolean | null ; autoRelateEventAttendees
?: boolean | null ; enableActivityReminders
?: boolean | null ; enableClickCreateEvents
?: boolean | null ; enableDragAndDropScheduling
?: boolean | null ; enableEmailTracking
?: boolean | null ; enableGroupTasks
?: boolean | null ; enableListViewScheduling
?: boolean | null ; enableLogNote
?: boolean | null ; enableMultidayEvents
?: boolean | null ; enableRecurringEvents
?: boolean | null ; enableRecurringTasks
?: boolean | null ; enableRollUpActivToContactsAcct
?: boolean | null ; enableSidebarCalendarShortcut
?: boolean | null ; enableSimpleTaskCreateUI
?: boolean | null ; enableUNSTaskDelegatedToNotifications
?: boolean | null ; enableUserListViewCalendars
?: boolean | null ; meetingRequestsLogo
?: string | null ; showCustomLogoMeetingRequests
?: boolean | null ; showEventDetailsMultiUserCalendar
?: boolean | null ; showHomePageHoverLinksForEvents
?: boolean | null ; showMyTasksHoverLinks
?: boolean | null } Adjustments Settings Adjustments Settings: { enableAdjustments: boolean ; enableOwnerAdjustments: boolean }
Type declaration enable Adjustments: boolean enable Owner Adjustments: boolean Agent Config Buttons Agent Config Buttons: { button: string [] }
Agent Config Profile Assignments Agent Config Profile Assignments: { profile: string [] }
Agent Config Skills Agent Config Skills: { skill: string [] }
Agent Config User Assignments Agent Config User Assignments: { user: string [] }
Analytic Snapshot Analytic
Snapshot
: Metadata & { description
?: string | null ; groupColumn
?: string | null ; mappings
: AnalyticSnapshotMapping [] ; name
: string ; runningUser
?: string | null ; sourceReport
: string ; targetObject
: string } Analytic Snapshot Mapping Analytic Snapshot Mapping: { aggregateType?: string | null ; sourceField: string ; sourceType: string ; targetField: string }
Type declaration Optional aggregate Type?: string | null source Field: string source Type: string target Field: string Analytics Cloud Component Layout Item Analytics Cloud Component Layout Item: { assetType: string ; devName: string ; error?: string | null ; filter?: string | null ; height?: number | null ; hideOnError?: boolean | null ; showHeader?: boolean | null ; showSharing?: boolean | null ; showTitle?: boolean | null ; width?: string | null }
Type declaration asset Type: string dev Name: string Optional error?: string | null Optional filter?: string | null Optional height?: number | null Optional hide On Error?: boolean | null Optional show Header?: boolean | null Optional show Sharing?: boolean | null Optional show Title?: boolean | null Optional width?: string | null Analytics Settings Analytics
Settings
: Metadata & { alwaysGenPreviews
?: boolean | null ; analyticsAdoptionMetadata
?: boolean | null ; canAccessAnalyticsViaAPI
?: boolean | null ; canAnnotateDashboards
?: boolean | null ; canEnableSavedView
?: boolean | null ; canExploreDataConversationally
?: boolean | null ; canShareAppsWithCommunities
?: boolean | null ; canSubscribeDashboardWidgets
?: boolean | null ; canViewThumbnailAssets
?: boolean | null ; enableAnalyticsSubtotals
?: boolean | null ; enableAutoCompleteCombo
?: boolean | null ; enableDashboardComponentSnapshot
?: boolean | null ; enableDashboardFlexiTable
?: boolean | null ; enableEmailReportsToPortalUsers
?: boolean | null ; enableFloatingReportHeaders
?: boolean | null ; enableInsights
?: boolean | null ; enableLightningReportBuilder
?: boolean | null ; enableLotusNotesImages
?: boolean | null ; enableMassEnableReportBuilder
?: boolean | null ; enableNewChartsEngine
?: boolean | null ; enablePowerInsights
?: boolean | null ; enableRemoveFooterForRepDisplay
?: boolean | null ; enableRemoveFooterFromRepExp
?: boolean | null ; enableReportFieldToFieldPref
?: boolean | null ; enableReportUniqueRowCountPref
?: boolean | null ; enableSFXJoinedReportsEnable
?: boolean | null ; enableSmartDataDiscovery
?: boolean | null ; enableUseOldChartsLookAndFeel
?: boolean | null ; enableWaveReplication
?: boolean | null ; enableWaveSharingInheritance
?: boolean | null ; enableWaveTemplate
?: boolean | null ; enableWaveTrendedDatasetCleanup
?: boolean | null } Animation Rule Animation
Rule
: Metadata & { animationFrequency
: string ; developerName
: string ; isActive
: boolean ; masterLabel
: string ; recordTypeContext
: string ; recordTypeName
?: string | null ; sobjectType
: string ; targetField
: string ; targetFieldChangeToValues
: string } Apex Page Apex
Page
: MetadataWithContent & { apiVersion
: number ; availableInTouch
?: boolean | null ; confirmationTokenRequired
?: boolean | null ; description
?: string | null ; label
: string ; packageVersions
: PackageVersion [] } Apex Settings Apex
Settings
: Metadata & { enableAggregateCodeCoverageOnly
?: boolean | null ; enableApexAccessRightsPref
?: boolean | null ; enableApexApprovalLockUnlock
?: boolean | null ; enableApexCtrlImplicitWithSharingPref
?: boolean | null ; enableApexPropertyGetterPref
?: boolean | null ; enableAuraApexCtrlAuthUserAccessCheckPref
?: boolean | null ; enableAuraApexCtrlGuestUserAccessCheckPref
?: boolean | null ; enableCompileOnDeploy
?: boolean | null ; enableDisableParallelApexTesting
?: boolean | null ; enableDoNotEmailDebugLog
?: boolean | null ; enableGaplessTestAutoNum
?: boolean | null ; enableMngdCtrlActionAccessPref
?: boolean | null ; enableNonCertifiedApexMdCrud
?: boolean | null } Apex Test Suite Apex
Test
Suite
: Metadata & { testClassName
: string [] } App Brand App Brand: { footerColor?: string | null ; headerColor?: string | null ; logo?: string | null ; logoVersion?: number | null ; shouldOverrideOrgTheme?: boolean | null }
Type declaration Optional footer Color?: string | null Optional header Color?: string | null Optional logo?: string | null Optional logo Version?: number | null Optional should Override Org Theme?: boolean | null App Component List App Component List: { alignment: string ; components: string [] }
Type declaration alignment: string components: string [] App Experience Settings App
Experience
Settings
: Metadata & { doesHideAllAppsInAppLauncher
?: boolean | null } App Menu Item App Menu Item: { name: string ; type: string }
App Preferences App Preferences: { enableCustomizeMyTabs: boolean ; enableKeyboardShortcuts: boolean ; enableListViewHover: boolean ; enableListViewReskin: boolean ; enableMultiMonitorComponents: boolean ; enablePinTabs: boolean ; enableTabHover: boolean ; enableTabLimits: boolean ; saveUserSessions: boolean }
Type declaration enable Customize My Tabs: boolean enable Keyboard Shortcuts: boolean enable List View Hover: boolean enable List View Reskin: boolean enable Multi Monitor Components: boolean enable Pin Tabs: boolean enable Tab Hover: boolean enable Tab Limits: boolean save User Sessions: boolean Appointment Scheduling Policy Appointment
Scheduling
Policy
: Metadata & { appointmentStartTimeInterval
: string ; masterLabel
: string ; shouldConsiderCalendarEvents
: boolean ; shouldEnforceExcludedResource
: boolean ; shouldEnforceRequiredResource
: boolean ; shouldMatchSkill
: boolean ; shouldMatchSkillLevel
: boolean ; shouldRespectVisitingHours
: boolean ; shouldUsePrimaryMembers
: boolean ; shouldUseSecondaryMembers
: boolean } Approval Entry Criteria Approval
Entry
Criteria
: { booleanFilter
?: string | null ; criteriaItems
: FilterItem [] ; formula
?: string | null } Type declaration Optional boolean Filter?: string | null Optional formula?: string | null Approval Page Field Approval Page Field: { field: string [] }
Approval Process Approval
Process
: Metadata & { active
: boolean ; allowRecall
?: boolean | null ; allowedSubmitters
: ApprovalSubmitter [] ; approvalPageFields
?: ApprovalPageField | null ; approvalStep
: ApprovalStep [] ; description
?: string | null ; emailTemplate
?: string | null ; enableMobileDeviceAccess
?: boolean | null ; entryCriteria
?: ApprovalEntryCriteria | null ; finalApprovalActions
?: ApprovalAction | null ; finalApprovalRecordLock
?: boolean | null ; finalRejectionActions
?: ApprovalAction | null ; finalRejectionRecordLock
?: boolean | null ; initialSubmissionActions
?: ApprovalAction | null ; label
: string ; nextAutomatedApprover
?: NextAutomatedApprover | null ; postTemplate
?: string | null ; recallActions
?: ApprovalAction | null ; recordEditability
: string ; showApprovalHistory
?: boolean | null } Approval Step Type declaration Optional allow Delegate?: boolean | null Optional approval Actions?: ApprovalAction | null Optional description?: string | null Optional if Criteria Not Met?: string | null label: string name: string Optional rejection Actions?: ApprovalAction | null Approval Step Approver Approval
Step
Approver
: { approver
: Approver [] ; whenMultipleApprovers
?: string | null } Type declaration Optional when Multiple Approvers?: string | null Approval Step Reject Behavior Approval Step Reject Behavior: { type: string }
Approval Submitter Approval Submitter: { submitter?: string | null ; type: string }
Type declaration Optional submitter?: string | null type: string Approver Approver: { name?: string | null ; type: string }
Type declaration Optional name?: string | null type: string Archive Settings Archive
Settings
: Metadata & { enableEntityArchivingEnabled
?: boolean | null } Article Type Channel Display Article Type Template Article Type Template: { channel: string ; page?: string | null ; template: string }
Type declaration channel: string Optional page?: string | null template: string Async Result Async Result: { done: boolean ; id: string ; message?: string | null ; state: string ; statusCode?: string | null }
Type declaration done: boolean id: string Optional message?: string | null state: string Optional status Code?: string | null Attachment Attachment: { content: string ; name: string }
Type declaration content: string name: string Audience Criteria Value Audience Criteria Value: { city?: string | null ; country?: string | null ; domain?: string | null ; entityField?: string | null ; entityType?: string | null ; fieldValue?: string | null ; isEnabled?: string | null ; permissionName?: string | null ; permissionType?: string | null ; profile?: string | null ; subdivision?: string | null }
Type declaration Optional city?: string | null Optional country?: string | null Optional domain?: string | null Optional entity Field?: string | null Optional entity Type?: string | null Optional field Value?: string | null Optional is Enabled?: string | null Optional permission Name?: string | null Optional permission Type?: string | null Optional profile?: string | null Optional subdivision?: string | null Audience Criterion Audience
Criterion
: { criteriaNumber
?: number | null ; criterionValue
?: AudienceCriteriaValue | null ; operator
?: string | null ; type
: string } Type declaration Optional criteria Number?: number | null Optional operator?: string | null type: string Aura Definition Bundle Aura
Definition
Bundle
: Metadata & { SVGContent
?: string | null ; apiVersion
?: number | null ; controllerContent
?: string | null ; description
?: string | null ; designContent
?: string | null ; documentationContent
?: string | null ; helperContent
?: string | null ; markup
?: string | null ; modelContent
?: string | null ; packageVersions
: PackageVersion [] ; rendererContent
?: string | null ; styleContent
?: string | null ; testsuiteContent
?: string | null ; type
?: string | null } Auth Provider Auth
Provider
: Metadata & { appleTeam
?: string | null ; authorizeUrl
?: string | null ; consumerKey
?: string | null ; consumerSecret
?: string | null ; customMetadataTypeRecord
?: string | null ; defaultScopes
?: string | null ; ecKey
?: string | null ; errorUrl
?: string | null ; executionUser
?: string | null ; friendlyName
: string ; iconUrl
?: string | null ; idTokenIssuer
?: string | null ; includeOrgIdInIdentifier
?: boolean | null ; linkKickoffUrl
?: string | null ; logoutUrl
?: string | null ; oauthKickoffUrl
?: string | null ; plugin
?: string | null ; portal
?: string | null ; providerType
: string ; registrationHandler
?: string | null ; sendAccessTokenInHeader
?: boolean | null ; sendClientCredentialsInHeader
?: boolean | null ; sendSecretInApis
?: boolean | null ; ssoKickoffUrl
?: string | null ; tokenUrl
?: string | null ; userInfoUrl
?: string | null } Blockchain Settings Blockchain
Settings
: Metadata & { enableBcp
?: boolean | null ; enableBcpCoin
?: boolean | null } Bot Dialog Bot
Dialog
: { botDialogGroup
?: string | null ; botSteps
: BotStep [] ; description
?: string | null ; developerName
: string ; label
: string ; mlIntent
?: string | null ; mlIntentTrainingEnabled
?: boolean | null ; showInFooterMenu
?: boolean | null } Type declaration Optional bot Dialog Group?: string | null Optional description?: string | null developer Name: string label: string Optional ml Intent?: string | null Optional ml Intent Training Enabled?: boolean | null Optional show In Footer Menu?: boolean | null Bot Dialog Group Bot Dialog Group: { description?: string | null ; developerName: string ; label: string }
Type declaration Optional description?: string | null developer Name: string label: string Bot Invocation Bot
Invocation
: { invocationActionName
?: string | null ; invocationActionType
?: string | null ; invocationMappings
: BotInvocationMapping [] } Type declaration Optional invocation Action Name?: string | null Optional invocation Action Type?: string | null Bot Invocation Mapping Bot Invocation Mapping: { parameterName: string ; type: string ; value?: string | null ; variableName?: string | null ; variableType?: string | null }
Type declaration parameter Name: string type: string Optional value?: string | null Optional variable Name?: string | null Optional variable Type?: string | null Bot Message Bot Message: { message: string }
Bot Navigation Link Bot Navigation Link: { label?: string | null ; targetBotDialog: string }
Type declaration Optional label?: string | null target Bot Dialog: string Bot Quick Reply Option Bot Quick Reply Option: { literalValue: string }
Bot Settings Bot
Settings
: Metadata & { enableBots
?: boolean | null } Bot Step Type declaration Optional boolean Filter?: string | null Optional bot Invocation?: BotInvocation | null Optional bot Navigation?: BotNavigation | null type: string Bot Step Condition Bot Step Condition: { leftOperandName: string ; leftOperandType: string ; operatorType: string ; rightOperandValue?: string | null }
Type declaration left Operand Name: string left Operand Type: string operator Type: string Optional right Operand Value?: string | null Bot Variable Operand Bot Variable Operand: { disableAutoFill?: boolean | null ; sourceName?: string | null ; sourceType?: string | null ; sourceValue?: string | null ; targetName: string ; targetType: string }
Type declaration Optional disable Auto Fill?: boolean | null Optional source Name?: string | null Optional source Type?: string | null Optional source Value?: string | null target Name: string target Type: string Bot Variable Operation Bot
Variable
Operation
: { botInvocation
?: BotInvocation | null ; botMessages
: BotMessage [] ; botQuickReplyOptions
: BotQuickReplyOption [] ; botVariableOperands
: BotVariableOperand [] ; invalidInputBotNavigation
?: BotNavigation | null ; quickReplyOptionTemplate
?: string | null ; quickReplyType
?: string | null ; quickReplyWidgetType
?: string | null ; sourceVariableName
?: string | null ; sourceVariableType
?: string | null ; type
: string } Type declaration Optional bot Invocation?: BotInvocation | null Optional invalid Input Bot Navigation?: BotNavigation | null Optional quick Reply Option Template?: string | null Optional quick Reply Type?: string | null Optional quick Reply Widget Type?: string | null Optional source Variable Name?: string | null Optional source Variable Type?: string | null type: string Branding Set Branding
Set
: Metadata & { brandingSetProperty
: BrandingSetProperty [] ; description
?: string | null ; masterLabel
: string ; type
?: string | null } Branding Set Property Branding Set Property: { propertyName: string ; propertyValue?: string | null }
Type declaration property Name: string Optional property Value?: string | null Business Hours Entry Business
Hours
Entry
: Metadata & { active
?: boolean | null ; default
: boolean ; fridayEndTime
?: string | null ; fridayStartTime
?: string | null ; mondayEndTime
?: string | null ; mondayStartTime
?: string | null ; name
?: string | null ; saturdayEndTime
?: string | null ; saturdayStartTime
?: string | null ; sundayEndTime
?: string | null ; sundayStartTime
?: string | null ; thursdayEndTime
?: string | null ; thursdayStartTime
?: string | null ; timeZoneId
?: string | null ; tuesdayEndTime
?: string | null ; tuesdayStartTime
?: string | null ; wednesdayEndTime
?: string | null ; wednesdayStartTime
?: string | null } Business Process Business
Process
: Metadata & { description
?: string | null ; isActive
?: boolean | null ; values
: PicklistValue [] } CMSConnect Asset CMSConnect Asset: { assetPath: string ; assetType: string ; sortOrder: number }
Type declaration asset Path: string asset Type: string sort Order: number CMSConnect Language CMSConnect Language: { cmsLanguage: string ; language: string }
Type declaration cms Language: string language: string CMSConnect Personalization CMSConnect Personalization: { connectorPage: string ; connectorPageAsset: string }
Type declaration connector Page: string connector Page Asset: string CMSConnect Resource Definition CMSConnect Resource Definition: { developerName: string ; masterLabel: string ; options: number ; payloadType: string ; resourceIdPath?: string | null ; resourceNamePath?: string | null ; resourcePath: string ; rootNodePath?: string | null }
Type declaration developer Name: string master Label: string options: number payload Type: string Optional resource Id Path?: string | null Optional resource Name Path?: string | null resource Path: string Optional root Node Path?: string | null CMSConnect Resource Type CMSConnect
Resource
Type
: { cmsConnectResourceDefinition
: CMSConnectResourceDefinition [] ; developerName
: string ; masterLabel
: string ; resourceType
: string } Type declaration developer Name: string master Label: string resource Type: string CMSConnect Source CMSConnect
Source
: Metadata & { cmsConnectAsset
: CMSConnectAsset [] ; cmsConnectLanguage
: CMSConnectLanguage [] ; cmsConnectPersonalization
?: CMSConnectPersonalization | null ; cmsConnectResourceType
: CMSConnectResourceType [] ; connectionType
: string ; cssScope
?: string | null ; developerName
: string ; languageEnabled
?: string | null ; masterLabel
: string ; namedCredential
?: string | null ; personalizationEnabled
?: string | null ; rootPath
?: string | null ; sortOrder
: number ; status
: string ; type
: string ; websiteUrl
?: string | null } Call Center Call
Center
: Metadata & { adapterUrl
?: string | null ; customSettings
?: string | null ; displayName
: string ; displayNameLabel
: string ; internalNameLabel
: string ; sections
: CallCenterSection [] ; version
?: string | null } Call Center Item Call Center Item: { label: string ; name: string ; value: string }
Type declaration label: string name: string value: string Call Center Section Call
Center
Section
: { items
: CallCenterItem [] ; label
: string ; name
: string } Type declaration label: string name: string Campaign Influence Model Campaign
Influence
Model
: Metadata & { isActive
?: boolean | null ; isDefaultModel
: boolean ; isModelLocked
: boolean ; modelDescription
?: string | null ; name
: string ; recordPreference
?: string | null } Campaign Settings Campaign
Settings
: Metadata & { enableAutoCampInfluenceDisabled
?: boolean | null ; enableB2bmaCampaignInfluence2
?: boolean | null ; enableCampaignHistoryTrackEnabled
?: boolean | null ; enableCampaignInfluence2
?: boolean | null ; enableCampaignMemberTWCF
?: boolean | null ; enableSuppressNoValueCI2
?: boolean | null } Cancel Deploy Result Cancel Deploy Result: { done: boolean ; id: string }
Canvas Metadata Canvas
Metadata
: Metadata & { accessMethod
: string ; canvasOptions
?: string | null ; canvasUrl
: string ; lifecycleClass
?: string | null ; locationOptions
?: string | null ; samlInitiationMethod
?: string | null } Case Classification Settings Case
Classification
Settings
: Metadata & { caseClassificationRecommendations
?: boolean | null ; reRunAttributeBasedRules
?: boolean | null ; runAssignmentRules
?: boolean | null } Case Settings Case
Settings
: Metadata & { caseAssignNotificationTemplate
?: string | null ; caseAutoProcUser
?: boolean | null ; caseCloseNotificationTemplate
?: string | null ; caseCommentNotificationTemplate
?: string | null ; caseCreateNotificationTemplate
?: string | null ; caseFeedItemSettings
: FeedItemSettings [] ; caseFeedReadUnreadLtng
?: boolean | null ; caseMergeInLightning
?: boolean | null ; closeCaseThroughStatusChange
?: boolean | null ; defaultCaseFeedLayoutOn
?: boolean | null ; defaultCaseOwner
?: string | null ; defaultCaseOwnerType
?: string | null ; defaultCaseUser
?: string | null ; emailActionDefaultsHandlerClass
?: string | null ; emailToCase
?: EmailToCaseSettings | null ; enableCaseFeed
?: boolean | null ; enableCollapseEmailThread
?: boolean | null ; enableDraftEmails
?: boolean | null ; enableEarlyEscalationRuleTriggers
?: boolean | null ; enableEmailActionDefaultsHandler
?: boolean | null ; enableSuggestedArticlesApplication
?: boolean | null ; enableSuggestedArticlesCustomerPortal
?: boolean | null ; enableSuggestedArticlesPartnerPortal
?: boolean | null ; enableSuggestedSolutions
?: boolean | null ; escalateCaseBefore
?: boolean | null ; genericMessageEnabled
?: boolean | null ; keepRecordTypeOnAssignmentRule
?: boolean | null ; notifyContactOnCaseComment
?: boolean | null ; notifyDefaultCaseOwner
?: boolean | null ; notifyOwnerOnCaseComment
?: boolean | null ; notifyOwnerOnCaseOwnerChange
?: boolean | null ; predictiveSupportEnabled
?: boolean | null ; showEmailAttachmentsInCaseAttachmentsRL
?: boolean | null ; showFewerCloseActions
?: boolean | null ; systemUserEmail
?: string | null ; useSystemEmailAddress
?: boolean | null ; useSystemUserAsDefaultCaseUser
?: boolean | null ; webToCase
?: WebToCaseSettings | null } Case Subject Particle Case
Subject
Particle
: Metadata & { index
: number ; textField
?: string | null ; type
: string } Certificate Certificate
: MetadataWithContent & { caSigned
: boolean ; encryptedWithPlatformEncryption
?: boolean | null ; expirationDate
?: string | null ; keySize
?: number | null ; masterLabel
: string ; privateKeyExportable
?: boolean | null } Channel Layout Channel
Layout
: Metadata & { enabledChannels
: string [] ; label
: string ; layoutItems
: ChannelLayoutItem [] ; recordType
?: string | null } Channel Layout Item Channel Layout Item: { field: string }
Chart Summary Chart Summary: { aggregate?: string | null ; axisBinding?: string | null ; column: string }
Type declaration Optional aggregate?: string | null Optional axis Binding?: string | null column: string Chatter Answers Reputation Level Chatter Answers Reputation Level: { name: string ; value: number }
Type declaration name: string value: number Chatter Answers Settings Chatter
Answers
Settings
: Metadata & { emailFollowersOnBestAnswer
?: boolean | null ; emailFollowersOnReply
?: boolean | null ; emailOwnerOnPrivateReply
?: boolean | null ; emailOwnerOnReply
?: boolean | null ; enableAnswerViaEmail
?: boolean | null ; enableChatterAnswers
: boolean ; enableFacebookSSO
?: boolean | null ; enableInlinePublisher
?: boolean | null ; enableReputation
?: boolean | null ; enableRichTextEditor
?: boolean | null ; facebookAuthProvider
?: string | null ; showInPortals
?: boolean | null } Chatter EmailsMDSettings Chatter
EmailsMDSettings
: Metadata & { enableChatterDigestEmailsApiOnly
?: boolean | null ; enableChatterEmailAttachment
?: boolean | null ; enableCollaborationEmail
?: boolean | null ; enableDisplayAppDownloadBadges
?: boolean | null ; enableEmailReplyToChatter
?: boolean | null ; enableEmailToChatter
?: boolean | null } Chatter Extension Chatter
Extension
: Metadata & { compositionComponent
: string ; description
: string ; extensionName
: string ; headerText
?: string | null ; hoverText
?: string | null ; icon
: string ; isProtected
?: boolean | null ; masterLabel
: string ; renderComponent
: string ; type
: string } Chatter Settings Chatter
Settings
: Metadata & { allowChatterGroupArchiving
?: boolean | null ; allowRecordsInChatterGroup
?: boolean | null ; allowSharingInChatterGroup
?: boolean | null ; enableApprovalRequest
?: boolean | null ; enableChatter
?: boolean | null ; enableChatterEmoticons
?: boolean | null ; enableFeedEdit
?: boolean | null ; enableFeedPinning
?: boolean | null ; enableFeedsDraftPosts
?: boolean | null ; enableFeedsRichText
?: boolean | null ; enableInviteCsnUsers
?: boolean | null ; enableOutOfOfficeEnabledPref
?: boolean | null ; enableRichLinkPreviewsInFeed
?: boolean | null ; enableTodayRecsInFeed
?: boolean | null ; unlistedGroupsEnabled
?: boolean | null } Clean Data Service Clean
Data
Service
: Metadata & { cleanRules
: CleanRule [] ; description
: string ; masterLabel
: string ; matchEngine
: string } Clean Rule Clean
Rule
: { bulkEnabled
: boolean ; bypassTriggers
: boolean ; bypassWorkflow
: boolean ; description
: string ; developerName
: string ; fieldMappings
: FieldMapping [] ; masterLabel
: string ; matchRule
: string ; sourceSobjectType
: string ; status
: string ; targetSobjectType
: string } Type declaration bulk Enabled: boolean bypass Triggers: boolean bypass Workflow: boolean description: string developer Name: string master Label: string match Rule: string source Sobject Type: string status: string target Sobject Type: string Code Coverage Result Type declaration id: string name: string Optional namespace?: string | null num Locations: number num Locations Not Covered: number type: string Code Coverage Warning Code Coverage Warning: { id: string ; message: string ; name?: string | null ; namespace?: string | null }
Type declaration id: string message: string Optional name?: string | null Optional namespace?: string | null Code Location Code Location: { column: number ; line: number ; numExecutions: number ; time: number }
Type declaration column: number line: number num Executions: number time: number Command Action Param Command Action Param: { defaultValue?: string | null ; description?: string | null ; name: string ; required?: boolean | null ; type: string }
Type declaration Optional default Value?: string | null Optional description?: string | null name: string Optional required?: boolean | null type: string Command Action Response Command Action Response: { template: string }
Communities Settings Communities
Settings
: Metadata & { canModerateAllFeedPosts
?: boolean | null ; canModerateInternalFeedPosts
?: boolean | null ; embeddedVisualforcePages
?: boolean | null ; enableCommunityWorkspaces
?: boolean | null ; enableCspContactVisibilityPref
?: boolean | null ; enableCspNotesOnAccConPref
?: boolean | null ; enableEnablePRM
?: boolean | null ; enableExternalAccHierPref
?: boolean | null ; enableGuestRecordReassignOrgPref
?: boolean | null ; enableInviteChatterGuestEnabled
?: boolean | null ; enableNetPortalUserReportOpts
?: boolean | null ; enableNetworksEnabled
?: boolean | null ; enableOotbProfExtUserOpsEnable
?: boolean | null ; enablePRMAccRelPref
?: boolean | null ; enablePowerCustomerCaseStatus
?: boolean | null ; enableRelaxPartnerAccountFieldPref
?: boolean | null ; enableUsernameUniqForOrgPref
?: boolean | null } Community Community
: Metadata & { active
?: boolean | null ; chatterAnswersFacebookSsoUrl
?: string | null ; communityFeedPage
?: string | null ; dataCategoryName
?: string | null ; description
?: string | null ; emailFooterDocument
?: string | null ; emailHeaderDocument
?: string | null ; emailNotificationUrl
?: string | null ; enableChatterAnswers
?: boolean | null ; enablePrivateQuestions
?: boolean | null ; expertsGroup
?: string | null ; portal
?: string | null ; reputationLevels
?: ReputationLevels | null ; showInPortal
?: boolean | null ; site
?: string | null } Community Custom Theme Layout Type Community Custom Theme Layout Type: { description?: string | null ; label: string }
Type declaration Optional description?: string | null label: string Community Roles Community Roles: { customerUserRole?: string | null ; employeeUserRole?: string | null ; partnerUserRole?: string | null }
Type declaration Optional customer User Role?: string | null Optional employee User Role?: string | null Optional partner User Role?: string | null Community Template Bundle Info Community Template Bundle Info: { description?: string | null ; image?: string | null ; order: number ; title: string ; type: string }
Type declaration Optional description?: string | null Optional image?: string | null order: number title: string type: string Community Template Definition Community
Template
Definition
: Metadata & { baseTemplate
?: string | null ; bundlesInfo
: CommunityTemplateBundleInfo [] ; category
: string ; defaultBrandingSet
?: string | null ; defaultThemeDefinition
: string ; description
?: string | null ; enableExtendedCleanUpOnDelete
?: boolean | null ; masterLabel
: string ; navigationLinkSet
: NavigationLinkSet [] ; pageSetting
: CommunityTemplatePageSetting [] ; publisher
?: string | null } Community Template Page Setting Community Template Page Setting: { page: string ; themeLayout: string }
Type declaration page: string theme Layout: string Community Theme Route Override Community Theme Route Override: { customThemeLayoutType?: string | null ; pageAttributes: string ; pageType: string ; themeLayoutType?: string | null }
Type declaration Optional custom Theme Layout Type?: string | null page Attributes: string page Type: string Optional theme Layout Type?: string | null Community Theme Setting Community Theme Setting: { customThemeLayoutType?: string | null ; themeLayout: string ; themeLayoutType?: string | null }
Type declaration Optional custom Theme Layout Type?: string | null theme Layout: string Optional theme Layout Type?: string | null Compact Layout Compact
Layout
: Metadata & { fields
: string [] ; label
: string } Component Instance Type declaration component Name: string Optional visibility Rule?: UiFormulaRule | null Component Instance Property Component Instance Property: { name?: string | null ; type?: string | null ; value?: string | null }
Type declaration Optional name?: string | null Optional type?: string | null Optional value?: string | null Connected App Attribute Connected App Attribute: { formula: string ; key: string }
Type declaration formula: string key: string Connected App Canvas Config Connected App Canvas Config: { accessMethod: string ; canvasUrl: string ; lifecycleClass?: string | null ; locations: string [] ; options: string [] ; samlInitiationMethod?: string | null }
Type declaration access Method: string canvas Url: string Optional lifecycle Class?: string | null locations: string [] options: string [] Optional saml Initiation Method?: string | null Connected App Ip Range Connected App Ip Range: { description?: string | null ; end: string ; start: string }
Type declaration Optional description?: string | null end: string start: string Connected App Mobile Detail Config Connected App Mobile Detail Config: { applicationBinaryFile?: string | null ; applicationBinaryFileName?: string | null ; applicationBundleIdentifier?: string | null ; applicationFileLength?: number | null ; applicationIconFile?: string | null ; applicationIconFileName?: string | null ; applicationInstallUrl?: string | null ; devicePlatform: string ; deviceType?: string | null ; minimumOsVersion?: string | null ; privateApp?: boolean | null ; version: string }
Type declaration Optional application Binary File?: string | null Optional application Binary File Name?: string | null Optional application Bundle Identifier?: string | null Optional application File Length?: number | null Optional application Icon File?: string | null Optional application Icon File Name?: string | null Optional application Install Url?: string | null device Platform: string Optional device Type?: string | null Optional minimum Os Version?: string | null Optional private App?: boolean | null version: string Connected App Oauth Config Connected
App
Oauth
Config
: { callbackUrl
: string ; certificate
?: string | null ; consumerKey
?: string | null ; consumerSecret
?: string | null ; idTokenConfig
?: ConnectedAppOauthIdToken | null ; isAdminApproved
?: boolean | null ; scopes
: string [] ; singleLogoutUrl
?: string | null } Type declaration callback Url: string Optional certificate?: string | null Optional consumer Key?: string | null Optional consumer Secret?: string | null Optional is Admin Approved?: boolean | null scopes: string [] Optional single Logout Url?: string | null Connected App Oauth Id Token Connected App Oauth Id Token: { idTokenAudience?: string | null ; idTokenIncludeAttributes?: boolean | null ; idTokenIncludeCustomPerms?: boolean | null ; idTokenIncludeStandardClaims?: boolean | null ; idTokenValidity?: number | null }
Type declaration Optional id Token Audience?: string | null Optional id Token Include Attributes?: boolean | null Optional id Token Include Custom Perms?: boolean | null Optional id Token Include Standard Claims?: boolean | null Optional id Token Validity?: number | null Connected App Saml Config Connected App Saml Config: { acsUrl: string ; certificate?: string | null ; encryptionCertificate?: string | null ; encryptionType?: string | null ; entityUrl: string ; issuer?: string | null ; samlIdpSLOBindingEnum?: string | null ; samlNameIdFormat?: string | null ; samlSloUrl?: string | null ; samlSubjectCustomAttr?: string | null ; samlSubjectType: string }
Type declaration acs Url: string Optional certificate?: string | null Optional encryption Certificate?: string | null Optional encryption Type?: string | null entity Url: string Optional issuer?: string | null Optional saml IdpSLOBinding Enum?: string | null Optional saml Name Id Format?: string | null Optional saml Slo Url?: string | null Optional saml Subject Custom Attr?: string | null saml Subject Type: string Connected App Settings Connected
App
Settings
: Metadata & { enableAdminApprovedAppsOnly
?: boolean | null ; enableSkipUserProvisioningWizardWelcomePage
?: boolean | null } Container Container
: { height
?: number | null ; isContainerAutoSizeEnabled
: boolean ; region
: string ; sidebarComponents
: SidebarComponent [] ; style
: string ; unit
: string ; width
?: number | null } Type declaration Optional height?: number | null is Container Auto Size Enabled: boolean region: string style: string unit: string Optional width?: number | null Content Asset Link Content Asset Link: { access: string ; isManagingWorkspace?: boolean | null ; name?: string | null }
Type declaration access: string Optional is Managing Workspace?: boolean | null Optional name?: string | null Content Asset Relationships Content Asset Version Content Asset Version: { number: string ; pathOnClient: string ; zipEntry?: string | null }
Type declaration number: string path On Client: string Optional zip Entry?: string | null Content Settings Content
Settings
: Metadata & { enableChatterFileLink
?: boolean | null ; enableContent
?: boolean | null ; enableContentAutoAssign
?: boolean | null ; enableContentDistForPortalUsers
?: boolean | null ; enableContentDistPwOptionsBit1
?: boolean | null ; enableContentDistPwOptionsBit2
?: boolean | null ; enableContentDistribution
?: boolean | null ; enableContentSupportMultiLanguage
?: boolean | null ; enableContentWorkspaceAccess
?: boolean | null ; enableFileShareSetByRecord
?: boolean | null ; enableFilesUsrShareNetRestricted
?: boolean | null ; enableJPGPreviews
?: boolean | null ; enableLibraryManagedFiles
?: boolean | null ; enableSiteGuestUserToUploadFiles
?: boolean | null ; enableUploadFilesOnAttachments
?: boolean | null ; skipContentAssetTriggers
?: boolean | null ; skipContentAssetTriggersOnDeploy
?: boolean | null } Contract Settings Contract
Settings
: Metadata & { autoCalculateEndDate
?: boolean | null ; autoExpirationDelay
?: string | null ; autoExpirationRecipient
?: string | null ; autoExpireContracts
?: boolean | null ; enableContractHistoryTracking
?: boolean | null ; notifyOwnersOnContractExpiration
?: boolean | null } Conversation Context Variable Conversation
Context
Variable
: { SObjectType
?: string | null ; contextVariableMappings
: ConversationContextVariableMapping [] ; dataType
: string ; developerName
: string ; label
: string } Type declaration Optional SObject Type?: string | null data Type: string developer Name: string label: string Conversation Context Variable Mapping Conversation Context Variable Mapping: { SObjectType: string ; fieldName: string ; messageType: string }
Type declaration SObject Type: string field Name: string message Type: string Conversation Record Lookup Conversation
Record
Lookup
: { SObjectType
: string ; lookupFields
: ConversationRecordLookupField [] ; maxLookupResults
: number ; sourceVariableName
: string ; sourceVariableType
: string ; targetVariableName
: string } Type declaration SObject Type: string max Lookup Results: number source Variable Name: string source Variable Type: string target Variable Name: string Conversation Record Lookup Field Conversation Record Lookup Field: { fieldName: string }
Conversation System Message Conversation System Message Mapping Conversation System Message Mapping: { mappingType: string ; parameterType: string ; variableName: string }
Type declaration mapping Type: string parameter Type: string variable Name: string Conversation Variable Conversation Variable: { SObjectType?: string | null ; collectionType?: string | null ; dataType: string ; developerName: string ; label: string }
Type declaration Optional SObject Type?: string | null Optional collection Type?: string | null data Type: string developer Name: string label: string Cors Whitelist Origin Cors
Whitelist
Origin
: Metadata & { urlPattern
: string } Countries And States Countries
And
States
: { countries
: Country [] } Country Country
: { active
: boolean ; integrationValue
: string ; isoCode
: string ; label
: string ; orgDefault
: boolean ; standard
: boolean ; states
: State [] ; visible
: boolean } Type declaration active: boolean integration Value: string iso Code: string label: string org Default: boolean standard: boolean visible: boolean Csp Trusted Site Csp
Trusted
Site
: Metadata & { context
?: string | null ; description
?: string | null ; endpointUrl
: string ; isActive
: boolean } Currency Settings Currency
Settings
: Metadata & { enableCurrencyEffectiveDates
?: boolean | null ; enableCurrencySymbolWithMultiCurrency
?: boolean | null ; enableMultiCurrency
?: boolean | null ; isMultiCurrencyActivationAllowed
?: boolean | null ; isParenCurrencyConvDisabled
?: boolean | null } Custom Application Custom
Application
: Metadata & { actionOverrides
: AppActionOverride [] ; brand
?: AppBrand | null ; consoleConfig
?: ServiceCloudConsoleConfig | null ; defaultLandingTab
?: string | null ; description
?: string | null ; formFactors
: string [] ; isNavAutoTempTabsDisabled
?: boolean | null ; isNavPersonalizationDisabled
?: boolean | null ; isServiceCloudConsole
?: boolean | null ; label
?: string | null ; logo
?: string | null ; navType
?: string | null ; preferences
?: AppPreferences | null ; profileActionOverrides
: AppProfileActionOverride [] ; setupExperience
?: string | null ; subscriberTabs
: string [] ; tabs
: string [] ; uiType
?: string | null ; utilityBar
?: string | null ; workspaceConfig
?: AppWorkspaceConfig | null } Custom Application Component Custom
Application
Component
: Metadata & { buttonIconUrl
?: string | null ; buttonStyle
?: string | null ; buttonText
?: string | null ; buttonWidth
?: number | null ; height
?: number | null ; isHeightFixed
: boolean ; isHidden
: boolean ; isWidthFixed
: boolean ; visualforcePage
: string ; width
?: number | null } Custom Application Translation Custom Application Translation: { label: string ; name: string }
Type declaration label: string name: string Custom Data Type Component Translation Custom Data Type Component Translation: { developerSuffix: string ; label?: string | null }
Type declaration developer Suffix: string Optional label?: string | null Custom Data Type Translation Type declaration custom Data Type Name: string Optional description?: string | null Optional label?: string | null Custom Feed Filter Custom
Feed
Filter
: Metadata & { criteria
: FeedFilterCriterion [] ; description
?: string | null ; isProtected
?: boolean | null ; label
: string } Custom Field Custom
Field
: Metadata & { businessOwnerGroup
?: string | null ; businessOwnerUser
?: string | null ; businessStatus
?: string | null ; caseSensitive
?: boolean | null ; complianceGroup
?: string | null ; customDataType
?: string | null ; defaultValue
?: string | null ; deleteConstraint
?: string | null ; deprecated
?: boolean | null ; description
?: string | null ; displayFormat
?: string | null ; encryptionScheme
?: string | null ; escapeMarkup
?: boolean | null ; externalDeveloperName
?: string | null ; externalId
?: boolean | null ; fieldManageability
?: string | null ; formula
?: string | null ; formulaTreatBlanksAs
?: string | null ; inlineHelpText
?: string | null ; isAIPredictionField
?: boolean | null ; isConvertLeadDisabled
?: boolean | null ; isFilteringDisabled
?: boolean | null ; isNameField
?: boolean | null ; isSortingDisabled
?: boolean | null ; label
?: string | null ; length
?: number | null ; lookupFilter
?: LookupFilter | null ; maskChar
?: string | null ; maskType
?: string | null ; metadataRelationshipControllingField
?: string | null ; populateExistingRows
?: boolean | null ; precision
?: number | null ; referenceTargetField
?: string | null ; referenceTo
?: string | null ; relationshipLabel
?: string | null ; relationshipName
?: string | null ; relationshipOrder
?: number | null ; reparentableMasterDetail
?: boolean | null ; required
?: boolean | null ; restrictedAdminField
?: boolean | null ; scale
?: number | null ; securityClassification
?: string | null ; startingNumber
?: number | null ; stripMarkup
?: boolean | null ; summarizedField
?: string | null ; summaryFilterItems
: FilterItem [] ; summaryForeignKey
?: string | null ; summaryOperation
?: string | null ; trackFeedHistory
?: boolean | null ; trackHistory
?: boolean | null ; trackTrending
?: boolean | null ; translateData
?: boolean | null ; type
?: string | null ; unique
?: boolean | null ; valueSet
?: ValueSet | null ; visibleLines
?: number | null ; writeRequiresMasterRead
?: boolean | null } Custom Field Translation Type declaration Optional gender?: string | null Optional help?: string | null Optional label?: string | null name: string Optional relationship Label?: string | null Optional starts With?: string | null Custom Help Menu Item Custom Help Menu Item: { linkUrl: string ; masterLabel: string ; sortOrder: number }
Type declaration link Url: string master Label: string sort Order: number Custom Http Header Custom Http Header: { description?: string | null ; headerFieldName: string ; headerFieldValue: string ; isActive?: boolean | null }
Type declaration Optional description?: string | null header Field Name: string header Field Value: string Optional is Active?: boolean | null Custom Label Custom
Label
: Metadata & { categories
?: string | null ; language
: string ; protected
: boolean ; shortDescription
: string ; value
: string } Custom Label Translation Custom Label Translation: { label: string ; name: string }
Type declaration label: string name: string Custom Metadata Custom
Metadata
: Metadata & { description
?: string | null ; label
?: string | null ; protected
?: boolean | null ; values
: CustomMetadataValue [] } Custom Metadata Value Custom Metadata Value: { field: string ; value?: any | null }
Type declaration field: string Optional value?: any | null Custom Notification Type Custom
Notification
Type
: Metadata & { customNotifTypeName
: string ; description
?: string | null ; desktop
: boolean ; masterLabel
: string ; mobile
: boolean } Custom Object Custom
Object
: Metadata & { actionOverrides
: ActionOverride [] ; allowInChatterGroups
?: boolean | null ; articleTypeChannelDisplay
?: ArticleTypeChannelDisplay | null ; businessProcesses
: BusinessProcess [] ; compactLayoutAssignment
?: string | null ; compactLayouts
: CompactLayout [] ; customHelp
?: string | null ; customHelpPage
?: string | null ; customSettingsType
?: string | null ; deploymentStatus
?: string | null ; deprecated
?: boolean | null ; description
?: string | null ; enableActivities
?: boolean | null ; enableBulkApi
?: boolean | null ; enableDataTranslation
?: boolean | null ; enableDivisions
?: boolean | null ; enableEnhancedLookup
?: boolean | null ; enableFeeds
?: boolean | null ; enableHistory
?: boolean | null ; enableLicensing
?: boolean | null ; enableReports
?: boolean | null ; enableSearch
?: boolean | null ; enableSharing
?: boolean | null ; enableStreamingApi
?: boolean | null ; eventType
?: string | null ; externalDataSource
?: string | null ; externalName
?: string | null ; externalRepository
?: string | null ; externalSharingModel
?: string | null ; fieldSets
: FieldSet [] ; fields
: CustomField [] ; gender
?: string | null ; historyRetentionPolicy
?: HistoryRetentionPolicy | null ; household
?: boolean | null ; indexes
: Index [] ; label
?: string | null ; listViews
: ListView [] ; nameField
?: CustomField | null ; pluralLabel
?: string | null ; profileSearchLayouts
: ProfileSearchLayouts [] ; publishBehavior
?: string | null ; recordTypeTrackFeedHistory
?: boolean | null ; recordTypeTrackHistory
?: boolean | null ; recordTypes
: RecordType [] ; searchLayouts
?: SearchLayouts | null ; sharingModel
?: string | null ; sharingReasons
: SharingReason [] ; sharingRecalculations
: SharingRecalculation [] ; startsWith
?: string | null ; validationRules
: ValidationRule [] ; visibility
?: string | null ; webLinks
: WebLink [] } Custom Page Web Link Custom
Page
Web
Link
: Metadata & { availability
: string ; description
?: string | null ; displayType
: string ; encodingKey
?: string | null ; hasMenubar
?: boolean | null ; hasScrollbars
?: boolean | null ; hasToolbar
?: boolean | null ; height
?: number | null ; isResizable
?: boolean | null ; linkType
: string ; masterLabel
?: string | null ; openType
: string ; page
?: string | null ; position
?: string | null ; protected
: boolean ; requireRowSelection
?: boolean | null ; scontrol
?: string | null ; showsLocation
?: boolean | null ; showsStatus
?: boolean | null ; url
?: string | null ; width
?: number | null } Custom Page Web Link Translation Custom Page Web Link Translation: { label: string ; name: string }
Type declaration label: string name: string Custom Permission Dependency Required Custom Permission Dependency Required: { customPermission: string ; dependency: boolean }
Type declaration custom Permission: string dependency: boolean Custom Shortcut Custom
Shortcut
: DefaultShortcut & { description
?: string | null ; eventName
: string } Custom Site Custom
Site
: Metadata & { active
: boolean ; allowHomePage
: boolean ; allowStandardAnswersPages
?: boolean | null ; allowStandardIdeasPages
: boolean ; allowStandardLookups
: boolean ; allowStandardPortalPages
: boolean ; allowStandardSearch
: boolean ; analyticsTrackingCode
?: string | null ; authorizationRequiredPage
?: string | null ; bandwidthExceededPage
?: string | null ; browserXssProtection
: boolean ; changePasswordPage
?: string | null ; chatterAnswersForgotPasswordConfirmPage
?: string | null ; chatterAnswersForgotPasswordPage
?: string | null ; chatterAnswersHelpPage
?: string | null ; chatterAnswersLoginPage
?: string | null ; chatterAnswersRegistrationPage
?: string | null ; clickjackProtectionLevel
: string ; contentSniffingProtection
: boolean ; cspUpgradeInsecureRequests
: boolean ; customWebAddresses
: SiteWebAddress [] ; description
?: string | null ; enableAuraRequests
?: boolean | null ; favoriteIcon
?: string | null ; fileNotFoundPage
?: string | null ; forgotPasswordPage
?: string | null ; genericErrorPage
?: string | null ; guestProfile
?: string | null ; inMaintenancePage
?: string | null ; inactiveIndexPage
?: string | null ; indexPage
: string ; masterLabel
: string ; myProfilePage
?: string | null ; portal
?: string | null ; referrerPolicyOriginWhenCrossOrigin
: boolean ; requireHttps
: boolean ; requireInsecurePortalAccess
: boolean ; robotsTxtPage
?: string | null ; rootComponent
?: string | null ; selfRegPage
?: string | null ; serverIsDown
?: string | null ; siteAdmin
?: string | null ; siteRedirectMappings
: SiteRedirectMapping [] ; siteTemplate
?: string | null ; siteType
: string ; subdomain
?: string | null ; urlPathPrefix
?: string | null } Custom Tab Custom
Tab
: Metadata & { actionOverrides
: ActionOverride [] ; auraComponent
?: string | null ; customObject
?: boolean | null ; description
?: string | null ; flexiPage
?: string | null ; frameHeight
?: number | null ; hasSidebar
?: boolean | null ; icon
?: string | null ; label
?: string | null ; lwcComponent
?: string | null ; motif
?: string | null ; page
?: string | null ; scontrol
?: string | null ; splashPageLink
?: string | null ; url
?: string | null ; urlEncodingKey
?: string | null } Custom Tab Translation Custom Tab Translation: { label: string ; name: string }
Type declaration label: string name: string Custom Value Custom
Value
: Metadata & { color
?: string | null ; default
: boolean ; description
?: string | null ; isActive
?: boolean | null ; label
?: string | null } Dashboard Dashboard
: Metadata & { backgroundEndColor
: string ; backgroundFadeDirection
: string ; backgroundStartColor
: string ; chartTheme
?: string | null ; colorPalette
?: string | null ; dashboardChartTheme
?: string | null ; dashboardColorPalette
?: string | null ; dashboardFilters
: DashboardFilter [] ; dashboardGridLayout
?: DashboardGridLayout | null ; dashboardResultRefreshedDate
?: string | null ; dashboardResultRunningUser
?: string | null ; dashboardType
?: string | null ; description
?: string | null ; folderName
?: string | null ; isGridLayout
?: boolean | null ; leftSection
?: DashboardComponentSection | null ; middleSection
?: DashboardComponentSection | null ; numSubscriptions
?: number | null ; rightSection
?: DashboardComponentSection | null ; runningUser
?: string | null ; textColor
: string ; title
: string ; titleColor
: string ; titleSize
: number } Dashboard Component Dashboard
Component
: { autoselectColumnsFromReport
?: boolean | null ; chartAxisRange
?: string | null ; chartAxisRangeMax
?: number | null ; chartAxisRangeMin
?: number | null ; chartSummary
: ChartSummary [] ; componentChartTheme
?: string | null ; componentType
: string ; dashboardFilterColumns
: DashboardFilterColumn [] ; dashboardTableColumn
: DashboardTableColumn [] ; decimalPrecision
?: number | null ; displayUnits
?: string | null ; drillDownUrl
?: string | null ; drillEnabled
?: boolean | null ; drillToDetailEnabled
?: boolean | null ; enableHover
?: boolean | null ; expandOthers
?: boolean | null ; flexComponentProperties
?: DashboardFlexTableComponentProperties | null ; footer
?: string | null ; gaugeMax
?: number | null ; gaugeMin
?: number | null ; groupingColumn
: string [] ; groupingSortProperties
?: DashboardComponentGroupingSortProperties | null ; header
?: string | null ; indicatorBreakpoint1
?: number | null ; indicatorBreakpoint2
?: number | null ; indicatorHighColor
?: string | null ; indicatorLowColor
?: string | null ; indicatorMiddleColor
?: string | null ; legendPosition
?: string | null ; maxValuesDisplayed
?: number | null ; metricLabel
?: string | null ; page
?: string | null ; pageHeightInPixels
?: number | null ; report
?: string | null ; scontrol
?: string | null ; scontrolHeightInPixels
?: number | null ; showPercentage
?: boolean | null ; showPicturesOnCharts
?: boolean | null ; showPicturesOnTables
?: boolean | null ; showRange
?: boolean | null ; showTotal
?: boolean | null ; showValues
?: boolean | null ; sortBy
?: string | null ; title
?: string | null ; useReportChart
?: boolean | null } Type declaration Optional autoselect Columns From Report?: boolean | null Optional chart Axis Range?: string | null Optional chart Axis Range Max?: number | null Optional chart Axis Range Min?: number | null Optional component Chart Theme?: string | null component Type: string Optional decimal Precision?: number | null Optional display Units?: string | null Optional drill Down Url?: string | null Optional drill Enabled?: boolean | null Optional drill To Detail Enabled?: boolean | null Optional enable Hover?: boolean | null Optional expand Others?: boolean | null Optional footer?: string | null Optional gauge Max?: number | null Optional gauge Min?: number | null grouping Column: string [] Optional header?: string | null Optional indicator Breakpoint1?: number | null Optional indicator Breakpoint2?: number | null Optional indicator High Color?: string | null Optional indicator Low Color?: string | null Optional indicator Middle Color?: string | null Optional legend Position?: string | null Optional max Values Displayed?: number | null Optional metric Label?: string | null Optional page?: string | null Optional page Height In Pixels?: number | null Optional report?: string | null Optional scontrol?: string | null Optional scontrol Height In Pixels?: number | null Optional show Percentage?: boolean | null Optional show Pictures On Charts?: boolean | null Optional show Pictures On Tables?: boolean | null Optional show Range?: boolean | null Optional show Total?: boolean | null Optional show Values?: boolean | null Optional sort By?: string | null Optional title?: string | null Optional use Report Chart?: boolean | null Dashboard Component Column Dashboard Component Column: { breakPoint1?: number | null ; breakPoint2?: number | null ; breakPointOrder?: number | null ; highRangeColor?: number | null ; lowRangeColor?: number | null ; midRangeColor?: number | null ; reportColumn: string ; showSubTotal?: boolean | null ; showTotal?: boolean | null ; type: string }
Type declaration Optional break Point1?: number | null Optional break Point2?: number | null Optional break Point Order?: number | null Optional high Range Color?: number | null Optional low Range Color?: number | null Optional mid Range Color?: number | null report Column: string Optional show Sub Total?: boolean | null Optional show Total?: boolean | null type: string Dashboard Component Grouping Sort Dashboard Component Grouping Sort: { groupingLevel: string ; inheritedReportGroupingSort?: string | null ; sortColumn?: string | null ; sortOrder?: string | null }
Type declaration grouping Level: string Optional inherited Report Grouping Sort?: string | null Optional sort Column?: string | null Optional sort Order?: string | null Dashboard Component Grouping Sort Properties Dashboard Component Section Dashboard Component Sort Info Dashboard Component Sort Info: { sortColumn?: string | null ; sortOrder?: string | null }
Type declaration Optional sort Column?: string | null Optional sort Order?: string | null Dashboard Filter Column Dashboard Filter Column: { column: string }
Dashboard Filter Option Dashboard Filter Option: { operator: string ; values: string [] }
Type declaration operator: string values: string [] Dashboard Flex Table Component Properties Type declaration Optional decimal Precision?: number | null Optional hide Chatter Photos?: boolean | null Dashboard Grid Component Dashboard
Grid
Component
: { colSpan
: number ; columnIndex
: number ; dashboardComponent
: DashboardComponent ; rowIndex
: number ; rowSpan
: number } Type declaration col Span: number column Index: number row Index: number row Span: number Dashboard Grid Layout Dashboard
Grid
Layout
: { dashboardGridComponents
: DashboardGridComponent [] ; numberOfColumns
: number ; rowHeight
: number } Type declaration number Of Columns: number row Height: number Dashboard Mobile Settings Dashboard Mobile Settings: { enableDashboardIPadApp?: boolean | null }
Type declaration Optional enable DashboardIPad App?: boolean | null Dashboard Table Column Dashboard Table Column: { aggregateType?: string | null ; calculatePercent?: boolean | null ; column: string ; decimalPlaces?: number | null ; showSubTotal?: boolean | null ; showTotal?: boolean | null ; sortBy?: string | null }
Type declaration Optional aggregate Type?: string | null Optional calculate Percent?: boolean | null column: string Optional decimal Places?: number | null Optional show Sub Total?: boolean | null Optional show Total?: boolean | null Optional sort By?: string | null Data Category Data
Category
: { dataCategory
: DataCategory [] ; label
: string ; name
: string } Type declaration label: string name: string Data Category Group Data
Category
Group
: Metadata & { active
: boolean ; dataCategory
: DataCategory ; description
?: string | null ; label
: string ; objectUsage
?: ObjectUsage | null } Data Dot Com Settings Data
Dot
Com
Settings
: Metadata & { enableAccountExportButtonOff
?: boolean | null ; enableAccountImportButtonOff
?: boolean | null ; enableAllowDupeContactFromLead
?: boolean | null ; enableAllowDupeLeadFromContact
?: boolean | null ; enableCleanUpgradeRequested
?: boolean | null ; enableContactExportButtonOff
?: boolean | null ; enableContactImportButtonOff
?: boolean | null } Default Shortcut Default Shortcut: { action: string ; active: boolean ; keyCommand: string }
Type declaration action: string active: boolean key Command: string Delegate Group Delegate
Group
: Metadata & { customObjects
: string [] ; groups
: string [] ; label
: string ; loginAccess
: boolean ; permissionSets
: string [] ; profiles
: string [] ; roles
: string [] } Delete Result Delete
Result
: { errors
: Error [] ; fullName
: string ; success
: boolean } Type declaration full Name: string success: boolean Deploy Message Deploy Message: { changed: boolean ; columnNumber?: number | null ; componentType?: string | null ; created: boolean ; createdDate: string ; deleted: boolean ; fileName: string ; fullName: string ; id?: string | null ; lineNumber?: number | null ; problem?: string | null ; problemType?: string | null ; success: boolean }
Type declaration changed: boolean Optional column Number?: number | null Optional component Type?: string | null created: boolean created Date: string deleted: boolean file Name: string full Name: string Optional id?: string | null Optional line Number?: number | null Optional problem?: string | null Optional problem Type?: string | null success: boolean Deploy Options Deploy Options: { allowMissingFiles: boolean ; autoUpdatePackage: boolean ; checkOnly: boolean ; ignoreWarnings: boolean ; performRetrieve: boolean ; purgeOnDelete: boolean ; rollbackOnError: boolean ; runTests: string [] ; singlePackage: boolean ; testLevel: string }
Type declaration allow Missing Files: boolean auto Update Package: boolean check Only: boolean ignore Warnings: boolean perform Retrieve: boolean purge On Delete: boolean rollback On Error: boolean run Tests: string [] single Package: boolean test Level: string Deploy Result Deploy
Result
: { canceledBy
?: string | null ; canceledByName
?: string | null ; checkOnly
: boolean ; completedDate
?: string | null ; createdBy
: string ; createdByName
: string ; createdDate
: string ; details
: DeployDetails ; done
: boolean ; errorMessage
?: string | null ; errorStatusCode
?: string | null ; id
: string ; ignoreWarnings
: boolean ; lastModifiedDate
?: string | null ; numberComponentErrors
: number ; numberComponentsDeployed
: number ; numberComponentsTotal
: number ; numberTestErrors
: number ; numberTestsCompleted
: number ; numberTestsTotal
: number ; rollbackOnError
: boolean ; runTestsEnabled
: boolean ; startDate
?: string | null ; stateDetail
?: string | null ; status
: string ; success
: boolean } Type declaration Optional canceled By?: string | null Optional canceled By Name?: string | null check Only: boolean Optional completed Date?: string | null created By: string created By Name: string created Date: string done: boolean Optional error Message?: string | null Optional error Status Code?: string | null id: string ignore Warnings: boolean Optional last Modified Date?: string | null number Component Errors: number number Components Deployed: number number Components Total: number number Test Errors: number number Tests Completed: number number Tests Total: number rollback On Error: boolean run Tests Enabled: boolean Optional start Date?: string | null Optional state Detail?: string | null status: string success: boolean Deployment Settings Deployment
Settings
: Metadata & { doesSkipAsyncApexValidation
?: boolean | null } Describe Metadata Object Describe Metadata Object: { childXmlNames: string [] ; directoryName: string ; inFolder: boolean ; metaFile: boolean ; suffix?: string | null ; xmlName: string }
Type declaration child Xml Names: string [] directory Name: string in Folder: boolean meta File: boolean Optional suffix?: string | null xml Name: string Describe Metadata Result Describe
Metadata
Result
: { metadataObjects
: DescribeMetadataObject [] ; organizationNamespace
: string ; partialSaveAllowed
: boolean ; testRequired
: boolean } Type declaration organization Namespace: string partial Save Allowed: boolean test Required: boolean Describe Value Type Result Describe
Value
Type
Result
: { apiCreatable
: boolean ; apiDeletable
: boolean ; apiReadable
: boolean ; apiUpdatable
: boolean ; parentField
?: ValueTypeField | null ; valueTypeFields
: ValueTypeField [] } Type declaration api Creatable: boolean api Deletable: boolean api Readable: boolean api Updatable: boolean Optional parent Field?: ValueTypeField | null Dev Hub Settings Dev
Hub
Settings
: Metadata & { enableShapeExportPref
?: boolean | null } Discovery Settings Discovery
Settings
: Metadata & { enableEinsteinAnswersPref
?: boolean | null } Document Document
: MetadataWithContent & { description
?: string | null ; internalUseOnly
: boolean ; keywords
?: string | null ; name
?: string | null ; public
: boolean } Document Type Document
Type
: Metadata & { description
: string ; isActive
: boolean ; masterLabel
: string } Duplicate Rule Duplicate
Rule
: Metadata & { actionOnInsert
: string ; actionOnUpdate
: string ; alertText
?: string | null ; description
?: string | null ; duplicateRuleFilter
?: DuplicateRuleFilter | null ; duplicateRuleMatchRules
?: DuplicateRuleMatchRule [] | null ; isActive
: boolean ; masterLabel
: string ; operationsOnInsert
: string [] ; operationsOnUpdate
: string [] ; securityOption
: string ; sortOrder
: number } Duplicate Rule Filter Type declaration Optional boolean Filter?: string | null Duplicate Rule Filter Item Duplicate
Rule
Filter
Item
: FilterItem & { sortOrder
: number ; table
: string } Duplicate Rule Match Rule Duplicate
Rule
Match
Rule
: { matchRuleSObjectType
: string ; matchingRule
: string ; objectMapping
?: ObjectMapping | null } Type declaration match RuleSObject Type: string matching Rule: string Optional object Mapping?: ObjectMapping | null EACSettings EACSettings
: Metadata & { enableEACForEveryonePref
?: boolean | null ; enableInboxActivitySharing
?: boolean | null ; enableInsightsInTimeline
?: boolean | null ; enableInsightsInTimelineEacStd
?: boolean | null } Eclair Map Eclair Map: { boundingBoxBottom?: number | null ; boundingBoxLeft?: number | null ; boundingBoxRight?: number | null ; boundingBoxTop?: number | null ; mapLabel?: string | null ; mapName: string ; projection: string }
Type declaration Optional bounding Box Bottom?: number | null Optional bounding Box Left?: number | null Optional bounding Box Right?: number | null Optional bounding Box Top?: number | null Optional map Label?: string | null map Name: string projection: string Email Administration Settings Email
Administration
Settings
: Metadata & { enableComplianceBcc
?: boolean | null ; enableEmailConsentManagement
?: boolean | null ; enableEmailSenderIdCompliance
?: boolean | null ; enableEmailSpfCompliance
?: boolean | null ; enableEmailToSalesforce
?: boolean | null ; enableEmailWorkflowApproval
?: boolean | null ; enableEnhancedEmailEnabled
?: boolean | null ; enableHandleBouncedEmails
?: boolean | null ; enableHtmlEmail
?: boolean | null ; enableListEmailLogActivities
?: boolean | null ; enableResendBouncedEmails
?: boolean | null ; enableRestrictTlsToDomains
?: boolean | null ; enableSendThroughGmailPref
?: boolean | null ; enableSendViaExchangePref
?: boolean | null ; enableSendViaGmailPref
?: boolean | null ; enableSetMatchingEmailsOnBounce
?: boolean | null ; enableUseOrgFootersForExtTrans
?: boolean | null ; sendEmailsEvenWhenAutomationUpdatesSameRecord
?: boolean | null ; sendMassEmailNotification
?: boolean | null ; sendTextOnlySystemEmails
?: boolean | null } Email Integration Settings Email
Integration
Settings
: Metadata & { doesEmailLogAsEmailMessageInOutlook
?: boolean | null ; doesGmailStayConnectedToSalesforce
?: boolean | null ; enableContactAndEventSync
?: boolean | null ; enableEmailTrackingInMobile
?: boolean | null ; enableEngageForOutlook
?: boolean | null ; enableGmailIntegration
?: boolean | null ; enableOutlookIntegration
?: boolean | null ; enableProductivityFeatures
?: boolean | null ; enableSupplementalContactInfoInMobile
?: boolean | null ; isLayoutCustomizationAllowed
?: boolean | null ; shouldUseTrustedDomainsList
?: boolean | null } Email Services Address Email Services Address: { authorizedSenders?: string | null ; developerName: string ; isActive?: boolean | null ; localPart: string ; runAsUser: string }
Type declaration Optional authorized Senders?: string | null developer Name: string Optional is Active?: boolean | null local Part: string run As User: string Email Services Function Email
Services
Function
: Metadata & { apexClass
: string ; attachmentOption
: string ; authenticationFailureAction
: string ; authorizationFailureAction
: string ; authorizedSenders
?: string | null ; emailServicesAddresses
: EmailServicesAddress [] ; errorRoutingAddress
?: string | null ; functionInactiveAction
: string ; functionName
: string ; isActive
?: boolean | null ; isAuthenticationRequired
?: boolean | null ; isErrorRoutingEnabled
?: boolean | null ; isTextAttachmentsAsBinary
?: boolean | null ; isTlsRequired
?: boolean | null ; overLimitAction
: string } Email Template Email
Template
: MetadataWithContent & { apiVersion
?: number | null ; attachedDocuments
: string [] ; attachments
: Attachment [] ; available
: boolean ; description
?: string | null ; encodingKey
: string ; letterhead
?: string | null ; name
: string ; packageVersions
: PackageVersion [] ; relatedEntityType
?: string | null ; style
: string ; subject
?: string | null ; textOnly
?: string | null ; type
: string ; uiType
?: string | null } Email Template Settings Email
Template
Settings
: Metadata & { enableLwcEmailTemplateBuilder
?: boolean | null ; enableTemplateEnhancedFolderPref
?: boolean | null } Email To Case Routing Address Email To Case Routing Address: { addressType?: string | null ; authorizedSenders?: string | null ; caseOrigin?: string | null ; caseOwner?: string | null ; caseOwnerType?: string | null ; casePriority?: string | null ; createTask?: boolean | null ; emailAddress?: string | null ; emailServicesAddress?: string | null ; isVerified?: boolean | null ; routingName?: string | null ; saveEmailHeaders?: boolean | null ; taskStatus?: string | null }
Type declaration Optional address Type?: string | null Optional authorized Senders?: string | null Optional case Origin?: string | null Optional case Owner?: string | null Optional case Owner Type?: string | null Optional case Priority?: string | null Optional create Task?: boolean | null Optional email Address?: string | null Optional email Services Address?: string | null Optional is Verified?: boolean | null Optional routing Name?: string | null Optional save Email Headers?: boolean | null Optional task Status?: string | null Email To Case Settings Email
To
Case
Settings
: { enableE2CAttachmentAsFile
?: boolean | null ; enableE2CSourceTracking
?: boolean | null ; enableEmailToCase
?: boolean | null ; enableHtmlEmail
?: boolean | null ; enableOnDemandEmailToCase
?: boolean | null ; enableThreadIDInBody
?: boolean | null ; enableThreadIDInSubject
?: boolean | null ; notifyOwnerOnNewCaseEmail
?: boolean | null ; overEmailLimitAction
?: string | null ; preQuoteSignature
?: boolean | null ; routingAddresses
: EmailToCaseRoutingAddress [] ; unauthorizedSenderAction
?: string | null } Type declaration Optional enable E2CAttachment As File?: boolean | null Optional enable E2CSource Tracking?: boolean | null Optional enable Email To Case?: boolean | null Optional enable Html Email?: boolean | null Optional enable On Demand Email To Case?: boolean | null Optional enable ThreadIDIn Body?: boolean | null Optional enable ThreadIDIn Subject?: boolean | null Optional notify Owner On New Case Email?: boolean | null Optional over Email Limit Action?: string | null Optional pre Quote Signature?: boolean | null Optional unauthorized Sender Action?: string | null Embedded Service Appointment Settings Embedded Service Appointment Settings: { appointmentConfirmImg?: string | null ; enabled: boolean ; homeImg?: string | null ; logoImg?: string | null ; shouldShowExistingAppointment?: boolean | null ; shouldShowNewAppointment?: boolean | null }
Type declaration Optional appointment Confirm Img?: string | null enabled: boolean Optional home Img?: string | null Optional logo Img?: string | null Optional should Show Existing Appointment?: boolean | null Optional should Show New Appointment?: boolean | null Embedded Service Branding Embedded
Service
Branding
: Metadata & { contrastInvertedColor
?: string | null ; contrastPrimaryColor
?: string | null ; embeddedServiceConfig
: string ; font
?: string | null ; height
?: number | null ; masterLabel
: string ; navBarColor
?: string | null ; primaryColor
?: string | null ; secondaryColor
?: string | null ; width
?: number | null } Embedded Service Custom Component Embedded Service Custom Component: { componentBundleType?: string | null ; customComponent?: string | null ; customComponentType?: string | null }
Type declaration Optional component Bundle Type?: string | null Optional custom Component?: string | null Optional custom Component Type?: string | null Embedded Service Custom Label Embedded Service Custom Label: { customLabel?: string | null ; feature?: string | null ; labelKey?: string | null }
Type declaration Optional custom Label?: string | null Optional feature?: string | null Optional label Key?: string | null Embedded Service Flow Embedded Service Flow: { flow: string ; flowType: string ; isAuthenticationRequired: boolean }
Type declaration flow: string flow Type: string is Authentication Required: boolean Embedded Service Flow Config Embedded
Service
Flow
Config
: Metadata & { enabled
: boolean } Embedded Service Layout Embedded
Service
Layout
: { embeddedServiceLayoutRules
: EmbeddedServiceLayoutRule [] ; layout
: string ; layoutType
?: string | null } Type declaration layout: string Optional layout Type?: string | null Embedded Service Layout Rule Embedded Service Layout Rule: { appointmentStatus: string }
Type declaration appointment Status: string Embedded Service Live Agent Embedded
Service
Live
Agent
: Metadata & { avatarImg
?: string | null ; embeddedServiceConfig
: string ; embeddedServiceQuickActions
: EmbeddedServiceQuickAction [] ; enabled
: boolean ; fontSize
: string ; headerBackgroundImg
?: string | null ; isOfflineCaseEnabled
?: boolean | null ; isQueuePositionEnabled
?: boolean | null ; liveAgentChatUrl
?: string | null ; liveAgentContentUrl
?: string | null ; liveChatButton
: string ; liveChatDeployment
: string ; masterLabel
: string ; offlineCaseBackgroundImg
?: string | null ; prechatBackgroundImg
?: string | null ; prechatEnabled
: boolean ; prechatJson
?: string | null ; scenario
: string ; smallCompanyLogoImg
?: string | null ; waitingStateBackgroundImg
?: string | null } Embedded Service Menu Item Embedded Service Menu Item: { channel?: string | null ; channelType?: string | null ; displayOrder?: number | null ; phoneNumber?: string | null }
Type declaration Optional channel?: string | null Optional channel Type?: string | null Optional display Order?: number | null Optional phone Number?: string | null Embedded Service Menu Settings Embedded
Service
Menu
Settings
: Metadata & { branding
?: string | null ; embeddedServiceMenuItems
: EmbeddedServiceMenuItem [] ; isEnabled
?: boolean | null ; masterLabel
?: string | null ; site
?: string | null } Embedded Service Quick Action Embedded Service Quick Action: { embeddedServiceLiveAgent: string ; order: number ; quickActionDefinition: string ; quickActionType?: string | null }
Type declaration embedded Service Live Agent: string order: number quick Action Definition: string Optional quick Action Type?: string | null Encryption Key Settings Encryption
Key
Settings
: Metadata & { canOptOutOfDerivationWithBYOK
?: boolean | null ; enableCacheOnlyKeys
?: boolean | null ; enableReplayDetection
?: boolean | null } Enhanced Notes Settings Enhanced
Notes
Settings
: Metadata & { enableEnhancedNotes
?: boolean | null ; enableTasksOnEnhancedNotes
?: boolean | null } Entitlement Process Entitlement
Process
: Metadata & { SObjectType
?: string | null ; active
?: boolean | null ; businessHours
?: string | null ; description
?: string | null ; entryStartDateField
?: string | null ; exitCriteriaBooleanFilter
?: string | null ; exitCriteriaFilterItems
: FilterItem [] ; exitCriteriaFormula
?: string | null ; isRecordTypeApplied
?: boolean | null ; isVersionDefault
?: boolean | null ; milestones
: EntitlementProcessMilestoneItem [] ; name
?: string | null ; recordType
?: string | null ; versionMaster
?: string | null ; versionNotes
?: string | null ; versionNumber
?: number | null } Entitlement Process Milestone Item Entitlement
Process
Milestone
Item
: { businessHours
?: string | null ; criteriaBooleanFilter
?: string | null ; milestoneCriteriaFilterItems
: FilterItem [] ; milestoneCriteriaFormula
?: string | null ; milestoneName
?: string | null ; minutesCustomClass
?: string | null ; minutesToComplete
?: number | null ; successActions
: WorkflowActionReference [] ; timeTriggers
: EntitlementProcessMilestoneTimeTrigger [] ; useCriteriaStartTime
?: boolean | null } Type declaration Optional business Hours?: string | null Optional criteria Boolean Filter?: string | null milestone Criteria Filter Items: FilterItem [] Optional milestone Criteria Formula?: string | null Optional milestone Name?: string | null Optional minutes Custom Class?: string | null Optional minutes To Complete?: number | null Optional use Criteria Start Time?: boolean | null Entitlement Process Milestone Time Trigger Entitlement
Process
Milestone
Time
Trigger
: { actions
: WorkflowActionReference [] ; timeLength
?: number | null ; workflowTimeTriggerUnit
: string } Type declaration Optional time Length?: number | null workflow Time Trigger Unit: string Entitlement Settings Entitlement
Settings
: Metadata & { assetLookupLimitedToActiveEntitlementsOnAccount
?: boolean | null ; assetLookupLimitedToActiveEntitlementsOnContact
?: boolean | null ; assetLookupLimitedToSameAccount
?: boolean | null ; assetLookupLimitedToSameContact
?: boolean | null ; enableEntitlementVersioning
: boolean ; enableEntitlements
: boolean ; enableMilestoneFeedItem
?: boolean | null ; enableMilestoneStoppedTime
?: boolean | null ; entitlementLookupLimitedToActiveStatus
?: boolean | null ; entitlementLookupLimitedToSameAccount
?: boolean | null ; entitlementLookupLimitedToSameAsset
?: boolean | null ; entitlementLookupLimitedToSameContact
?: boolean | null ; ignoreMilestoneBusinessHours
?: boolean | null } Entitlement Template Entitlement
Template
: Metadata & { businessHours
?: string | null ; casesPerEntitlement
?: number | null ; entitlementProcess
?: string | null ; isPerIncident
?: boolean | null ; term
?: number | null ; type
?: string | null } Entity Implements Entity
Implements
: Metadata & { fieldMap
: FieldImplements [] ; interface
?: string | null ; isDefault
?: boolean | null } Error Error
: { extendedErrorDetails
: ExtendedErrorDetails [] ; fields
: string [] ; message
: string ; statusCode
: string } Type declaration fields: string [] message: string status Code: string Escalation Action Escalation Action: { assignedTo?: string | null ; assignedToTemplate?: string | null ; assignedToType?: string | null ; minutesToEscalation?: number | null ; notifyCaseOwner?: boolean | null ; notifyEmail: string [] ; notifyTo?: string | null ; notifyToTemplate?: string | null }
Type declaration Optional assigned To?: string | null Optional assigned To Template?: string | null Optional assigned To Type?: string | null Optional minutes To Escalation?: number | null Optional notify Case Owner?: boolean | null notify Email: string [] Optional notify To?: string | null Optional notify To Template?: string | null Essentials Settings Essentials
Settings
: Metadata & { emailConnectorEnabled
?: boolean | null ; essentialsAppEnabled
?: boolean | null } Essentials Trial Org Settings Essentials
Trial
Org
Settings
: Metadata & { enableSampleDataDeleted
?: boolean | null } Event Settings Event
Settings
: Metadata & { enableApexLimitEvents
?: boolean | null ; enableDeleteMonitoringData
?: boolean | null ; enableDynamicStreamingChannel
?: boolean | null ; enableEventLogWaveIntegration
?: boolean | null ; enableLoginForensics
?: boolean | null ; enableStreamingApi
?: boolean | null ; enableTerminateOldestSession
?: boolean | null ; enableTransactionSecurityPolicies
?: boolean | null } Experience Bundle Settings Experience
Bundle
Settings
: Metadata & { enableExperienceBundleMetadata
?: boolean | null } Extended Error Details Extended Error Details: { extendedErrorCode: string }
Type declaration extended Error Code: string External Connection Property External Connection Property: { propertyName: string ; propertyValue: string }
Type declaration property Name: string property Value: string External Data Source External
Data
Source
: Metadata & { authProvider
?: string | null ; certificate
?: string | null ; customConfiguration
?: string | null ; customHttpHeaders
: CustomHttpHeader [] ; endpoint
?: string | null ; isWritable
?: boolean | null ; label
: string ; oauthRefreshToken
?: string | null ; oauthScope
?: string | null ; oauthToken
?: string | null ; password
?: string | null ; principalType
: string ; protocol
: string ; repository
?: string | null ; type
: string ; username
?: string | null ; version
?: string | null } External Service Registration External
Service
Registration
: Metadata & { description
?: string | null ; label
: string ; namedCredential
?: string | null ; schema
?: string | null ; schemaType
?: string | null ; schemaUrl
?: string | null ; status
: string } External Services Settings External
Services
Settings
: Metadata & { enableEnhancedExternalServices
?: boolean | null } Feed Filter Criterion Feed Filter Criterion: { feedItemType: string ; feedItemVisibility?: string | null ; relatedSObjectType?: string | null }
Type declaration feed Item Type: string Optional feed Item Visibility?: string | null Optional relatedSObject Type?: string | null Feed Item Settings Feed Item Settings: { characterLimit?: number | null ; displayFormat?: string | null ; feedItemType: string }
Type declaration Optional character Limit?: number | null Optional display Format?: string | null feed Item Type: string Feed Layout Feed
Layout
: { autocollapsePublisher
?: boolean | null ; compactFeed
?: boolean | null ; feedFilterPosition
?: string | null ; feedFilters
: FeedLayoutFilter [] ; fullWidthFeed
?: boolean | null ; hideSidebar
?: boolean | null ; highlightExternalFeedItems
?: boolean | null ; leftComponents
: FeedLayoutComponent [] ; rightComponents
: FeedLayoutComponent [] ; useInlineFiltersInConsole
?: boolean | null } Type declaration Optional autocollapse Publisher?: boolean | null Optional compact Feed?: boolean | null Optional feed Filter Position?: string | null Optional full Width Feed?: boolean | null Optional hide Sidebar?: boolean | null Optional highlight External Feed Items?: boolean | null Optional use Inline Filters In Console?: boolean | null Feed Layout Component Feed Layout Component: { componentType: string ; height?: number | null ; page?: string | null }
Type declaration component Type: string Optional height?: number | null Optional page?: string | null Feed Layout Filter Feed Layout Filter: { feedFilterName?: string | null ; feedFilterType: string ; feedItemType?: string | null }
Type declaration Optional feed Filter Name?: string | null feed Filter Type: string Optional feed Item Type?: string | null Field Implements Field Implements: { field?: string | null ; interfaceField?: string | null }
Type declaration Optional field?: string | null Optional interface Field?: string | null Field Mapping Field
Mapping
: { SObjectType
: string ; developerName
: string ; fieldMappingRows
: FieldMappingRow [] ; masterLabel
: string } Type declaration SObject Type: string developer Name: string master Label: string Field Mapping Field Field Mapping Field: { dataServiceField: string ; dataServiceObjectName: string ; priority: number }
Type declaration data Service Field: string data Service Object Name: string priority: number Field Mapping Row Field
Mapping
Row
: { SObjectType
: string ; fieldMappingFields
: FieldMappingField [] ; fieldName
: string ; mappingOperation
: string } Type declaration SObject Type: string field Name: string mapping Operation: string Field Override Field Override: { field: string ; formula?: string | null ; literalValue?: string | null }
Type declaration field: string Optional formula?: string | null Optional literal Value?: string | null Field Service Settings Field
Service
Settings
: Metadata & { capacityUsageCalcClassId
?: string | null ; doesAllowEditSaForCrew
?: boolean | null ; doesShareSaParentWoWithAr
?: boolean | null ; doesShareSaWithAr
?: boolean | null ; enableWorkOrders
?: boolean | null ; fieldServiceNotificationsOrgPref
?: boolean | null ; fieldServiceOrgPref
?: boolean | null ; isGeoCodeSyncEnabled
?: boolean | null ; isLocationHistoryEnabled
?: boolean | null ; serviceAppointmentsDueDateOffsetOrgValue
?: number | null ; workOrderLineItemSearchFields
: string [] ; workOrderSearchFields
: string [] } Field Set Item Field Set Item: { field?: string | null ; isFieldManaged?: boolean | null ; isRequired?: boolean | null }
Type declaration Optional field?: string | null Optional is Field Managed?: boolean | null Optional is Required?: boolean | null Field Set Translation Field Set Translation: { label: string ; name: string }
Type declaration label: string name: string Field Value Field Value: { name: string ; value?: any | null }
Type declaration name: string Optional value?: any | null File Properties File Properties: { createdById: string ; createdByName: string ; createdDate: string ; fileName: string ; fullName: string ; id: string ; lastModifiedById: string ; lastModifiedByName: string ; lastModifiedDate: string ; manageableState?: string | null ; namespacePrefix?: string | null ; type: string }
Type declaration created By Id: string created By Name: string created Date: string file Name: string full Name: string id: string last Modified By Id: string last Modified By Name: string last Modified Date: string Optional manageable State?: string | null Optional namespace Prefix?: string | null type: string File Type Disposition Assignment Bean File Type Disposition Assignment Bean: { behavior: string ; fileType: string ; securityRiskFileType: boolean }
Type declaration behavior: string file Type: string security Risk File Type: boolean File Upload And Download Security Settings Files Connect Settings Files
Connect
Settings
: Metadata & { enableContentHubAllowed
?: boolean | null ; enableContentHubCvtLinksAllowed
?: boolean | null ; enableContentHubEOSearchLayout
?: boolean | null } Filter Item Filter Item: { field: string ; operation: string ; value?: string | null ; valueField?: string | null }
Type declaration field: string operation: string Optional value?: string | null Optional value Field?: string | null Find Similar Opp Filter Find Similar Opp Filter: { similarOpportunitiesDisplayColumns: string [] ; similarOpportunitiesMatchFields: string [] }
Type declaration similar Opportunities Display Columns: string [] similar Opportunities Match Fields: string [] Fiscal Year Settings Fiscal Year Settings: { fiscalYearNameBasedOn?: string | null ; startMonth?: string | null }
Type declaration Optional fiscal Year Name Based On?: string | null Optional start Month?: string | null Flexi Page Region Flexi
Page
Region
: { appendable
?: string | null ; componentInstances
: ComponentInstance [] ; mode
?: string | null ; name
: string ; prependable
?: string | null ; replaceable
?: string | null ; type
: string } Type declaration Optional appendable?: string | null Optional mode?: string | null name: string Optional prependable?: string | null Optional replaceable?: string | null type: string Flexi Page Template Instance Flow Action Call Input Parameter Flow Action Call Output Parameter Flow
Action
Call
Output
Parameter
: FlowBaseElement & { assignToReference
: string ; name
: string } Flow Apex Plugin Call Input Parameter Flow Apex Plugin Call Output Parameter Flow
Apex
Plugin
Call
Output
Parameter
: FlowBaseElement & { assignToReference
: string ; name
: string } Flow Category Items Flow Category Items: { flow: string }
Flow Choice Translation Type declaration Optional choice Text?: string | null name: string Flow Choice User Input Translation Type declaration Optional prompt Text?: string | null Flow Coverage Result Flow Coverage Result: { elementsNotCovered: string [] ; flowId: string ; flowName: string ; flowNamespace?: string | null ; numElements: number ; numElementsNotCovered: number ; processType: string }
Type declaration elements Not Covered: string [] flow Id: string flow Name: string Optional flow Namespace?: string | null num Elements: number num Elements Not Covered: number process Type: string Flow Coverage Warning Flow Coverage Warning: { flowId?: string | null ; flowName?: string | null ; flowNamespace?: string | null ; message: string }
Type declaration Optional flow Id?: string | null Optional flow Name?: string | null Optional flow Namespace?: string | null message: string Flow Definition Flow
Definition
: Metadata & { activeVersionNumber
?: number | null ; description
?: string | null ; masterLabel
?: string | null } Flow Definition Translation Flow
Definition
Translation
: { flows
: FlowTranslation [] ; fullName
: string ; label
?: string | null } Type declaration full Name: string Optional label?: string | null Flow Dynamic Choice Set Flow
Dynamic
Choice
Set
: FlowElement & { dataType
: string ; displayField
: string ; filters
: FlowRecordFilter [] ; limit
?: number | null ; object
: string ; outputAssignments
: FlowOutputFieldAssignment [] ; picklistField
?: string | null ; picklistObject
?: string | null ; sortField
?: string | null ; sortOrder
?: string | null ; valueField
?: string | null } Flow Element Flow
Element
: FlowBaseElement & { description
?: string | null ; name
?: string | null } Flow Element Reference Or Value Flow Element Reference Or Value: { booleanValue?: boolean | null ; dateTimeValue?: string | null ; dateValue?: string | null ; elementReference?: string | null ; numberValue?: number | null ; stringValue?: string | null }
Type declaration Optional boolean Value?: boolean | null Optional date Time Value?: string | null Optional date Value?: string | null Optional element Reference?: string | null Optional number Value?: number | null Optional string Value?: string | null Flow Formula Flow
Formula
: FlowElement & { dataType
?: string | null ; expression
: string ; scale
?: number | null } Flow Input Validation Rule Flow Input Validation Rule: { errorMessage: string ; formulaExpression: string }
Type declaration error Message: string formula Expression: string Flow Input Validation Rule Translation Flow Input Validation Rule Translation: { errorMessage?: string | null }
Type declaration Optional error Message?: string | null Flow Loop Flow
Loop
: FlowNode & { assignNextValueToReference
: string ; collectionReference
: string ; iterationOrder
?: string | null ; nextValueConnector
?: FlowConnector | null ; noMoreValuesConnector
?: FlowConnector | null } Flow Node Flow
Node
: FlowElement & { label
?: string | null ; locationX
: number ; locationY
: number } Flow Output Field Assignment Flow
Output
Field
Assignment
: FlowBaseElement & { assignToReference
: string ; field
: string } Flow Record Lookup Flow
Record
Lookup
: FlowNode & { assignNullValuesIfNoRecordsFound
?: boolean | null ; connector
?: FlowConnector | null ; faultConnector
?: FlowConnector | null ; filters
: FlowRecordFilter [] ; getFirstRecordOnly
?: boolean | null ; object
: string ; outputAssignments
: FlowOutputFieldAssignment [] ; outputReference
?: string | null ; queriedFields
: string [] ; sortField
?: string | null ; sortOrder
?: string | null ; storeOutputAutomatically
?: boolean | null } Flow Schedule Flow Schedule: { frequency?: string | null ; startDate?: string | null ; startTime?: string | null }
Type declaration Optional frequency?: string | null Optional start Date?: string | null Optional start Time?: string | null Flow Screen Flow
Screen
: FlowNode & { allowBack
?: boolean | null ; allowFinish
?: boolean | null ; allowPause
?: boolean | null ; connector
?: FlowConnector | null ; fields
: FlowScreenField [] ; helpText
?: string | null ; pausedText
?: string | null ; rules
: FlowScreenRule [] ; showFooter
?: boolean | null ; showHeader
?: boolean | null } Flow Screen Field Input Parameter Flow Screen Field Output Parameter Flow
Screen
Field
Output
Parameter
: FlowBaseElement & { assignToReference
: string ; name
: string } Flow Screen Field Translation Type declaration Optional field Text?: string | null Optional help Text?: string | null name: string Flow Screen Translation Flow
Screen
Translation
: { fields
: FlowScreenFieldTranslation [] ; helpText
?: string | null ; name
: string ; pausedText
?: string | null } Type declaration Optional help Text?: string | null name: string Optional paused Text?: string | null Flow Settings Flow
Settings
: Metadata & { enableFlowBREncodedFixEnabled
?: boolean | null ; enableFlowDeployAsActiveEnabled
?: boolean | null ; enableFlowFieldFilterEnabled
?: boolean | null ; enableFlowFormulasFixEnabled
?: boolean | null ; enableFlowInterviewSharingEnabled
?: boolean | null ; enableFlowNullPreviousValueFix
?: boolean | null ; enableFlowPauseEnabled
?: boolean | null ; enableFlowUseApexExceptionEmail
?: boolean | null ; enableInvocableFlowFixEnabled
?: boolean | null ; enableLightningRuntimeEnabled
?: boolean | null ; enableUseFlowBuilder
?: boolean | null ; isAccessToInvokedApexRequired
?: boolean | null ; isEnhancedFlowListViewVisible
?: boolean | null ; isManageFlowRequiredForAutomationCharts
?: boolean | null } Flow Stage Flow
Stage
: FlowElement & { isActive
: boolean ; label
: string ; stageOrder
: number } Flow Stage Translation Flow Stage Translation: { label?: string | null ; name: string }
Type declaration Optional label?: string | null name: string Flow Subflow Input Assignment Flow Subflow Output Assignment Flow
Subflow
Output
Assignment
: FlowBaseElement & { assignToReference
: string ; name
: string } Flow Text Template Translation Flow Text Template Translation: { name: string ; text?: string | null }
Type declaration name: string Optional text?: string | null Flow Translation Type declaration full Name: string Optional label?: string | null Flow Variable Flow
Variable
: FlowElement & { apexClass
?: string | null ; dataType
: string ; isCollection
?: boolean | null ; isInput
?: boolean | null ; isOutput
?: boolean | null ; objectType
?: string | null ; scale
?: number | null ; value
?: FlowElementReferenceOrValue | null } Flow Wait Event Input Parameter Flow Wait Event Output Parameter Flow
Wait
Event
Output
Parameter
: FlowBaseElement & { assignToReference
: string ; name
: string } Folder Folder
: Metadata & { accessType
?: string | null ; folderShares
: FolderShare [] ; name
: string ; publicFolderAccess
?: string | null ; sharedTo
?: SharedTo | null } Folder Share Folder Share: { accessLevel: string ; sharedTo: string ; sharedToType: string }
Type declaration access Level: string shared To: string shared To Type: string Forecast Range Settings Forecast Range Settings: { beginning: number ; displaying: number ; periodType: string }
Type declaration beginning: number displaying: number period Type: string Forecasting Category Mapping Forecasting
Category
Mapping
: { forecastingItemCategoryApiName
: string ; weightedSourceCategories
: WeightedSourceCategory [] } Type declaration forecasting Item Category Api Name: string Forecasting Displayed Family Settings Forecasting Displayed Family Settings: { productFamily?: string | null }
Type declaration Optional product Family?: string | null Forecasting Type Settings Type declaration active: boolean displayed Category Api Names: string [] forecasted Category Api Names: string [] forecasting Date Type: string has Product Family: boolean is Amount: boolean is Available: boolean is Quantity: boolean manager Adjustable Category Api Names: string [] master Label: string name: string Optional opportunity Split Name?: string | null owner Adjustable Category Api Names: string [] Optional territory2 Model Name?: string | null Form Form
: Metadata & { description
?: string | null ; formSections
: FormSection [] ; masterLabel
: string } Form Item Form Item: { emptySpace?: boolean | null ; expression?: string | null ; formLayoutableItem?: string | null ; helpText?: string | null }
Type declaration Optional empty Space?: boolean | null Optional expression?: string | null Optional form Layoutable Item?: string | null Optional help Text?: string | null Form Section Form
Section
: Metadata & { formColumns
: FormColumn [] ; masterLabel
: string ; tabOrderType
: string } Formula Settings Formula
Settings
: Metadata & { enableDSTAwareDatevalue
?: boolean | null } Global Quick Action Translation Global Quick Action Translation: { label: string ; name: string }
Type declaration label: string name: string Global Value Set Global
Value
Set
: Metadata & { customValue
: CustomValue [] ; description
?: string | null ; masterLabel
: string ; sorted
: boolean } Global Value Set Translation Google Apps Settings Google
Apps
Settings
: Metadata & { enableGmailButtons
?: boolean | null ; enableGmailButtonsAndLinks
?: boolean | null ; enableGmailLinks
?: boolean | null ; enableGoogleDocs
?: boolean | null ; enableGoogleDocsTab
?: boolean | null ; enableGoogleTalk
?: boolean | null ; googleAppsDomain
?: string | null ; googleAppsDomainLinked
?: boolean | null ; googleAppsDomainValidated
?: boolean | null } Group Group
: Metadata & { doesIncludeBosses
?: boolean | null ; name
: string } High Velocity Sales Settings High
Velocity
Sales
Settings
: Metadata & { enableDispositionCategory
?: boolean | null ; enableEngagementWaveAnalyticsPref
?: boolean | null ; enableHighVelocitySales
?: boolean | null ; enableHighVelocitySalesSetup
?: boolean | null } History Retention Policy History Retention Policy: { archiveAfterMonths: number ; archiveRetentionYears: number ; description?: string | null }
Type declaration archive After Months: number archive Retention Years: number Optional description?: string | null Holiday Holiday: { activityDate?: string | null ; businessHours: string [] ; description?: string | null ; endTime?: string | null ; isRecurring?: boolean | null ; name?: string | null ; recurrenceDayOfMonth?: number | null ; recurrenceDayOfWeek: string [] ; recurrenceDayOfWeekMask?: number | null ; recurrenceEndDate?: string | null ; recurrenceInstance?: string | null ; recurrenceInterval?: number | null ; recurrenceMonthOfYear?: string | null ; recurrenceStartDate?: string | null ; recurrenceType?: string | null ; startTime?: string | null }
Type declaration Optional activity Date?: string | null business Hours: string [] Optional description?: string | null Optional end Time?: string | null Optional is Recurring?: boolean | null Optional name?: string | null Optional recurrence Day Of Month?: number | null recurrence Day Of Week: string [] Optional recurrence Day Of Week Mask?: number | null Optional recurrence End Date?: string | null Optional recurrence Instance?: string | null Optional recurrence Interval?: number | null Optional recurrence Month Of Year?: string | null Optional recurrence Start Date?: string | null Optional recurrence Type?: string | null Optional start Time?: string | null Home Page Component Home
Page
Component
: Metadata & { body
?: string | null ; height
?: number | null ; links
: string [] ; page
?: string | null ; pageComponentType
: string ; showLabel
?: boolean | null ; showScrollbars
?: boolean | null ; width
?: string | null } Home Page Layout Home
Page
Layout
: Metadata & { narrowComponents
: string [] ; wideComponents
: string [] } Idea Reputation Level Idea Reputation Level: { name: string ; value: number }
Type declaration name: string value: number Ideas Settings Ideas
Settings
: Metadata & { enableChatterProfile
?: boolean | null ; enableHtmlIdea
?: boolean | null ; enableIdeaMultipleCategory
?: boolean | null ; enableIdeaThemes
?: boolean | null ; enableIdeas
?: boolean | null ; enableIdeasControllerExtensions
?: boolean | null ; enableIdeasReputation
?: boolean | null ; halfLife
?: number | null ; ideasProfilePage
?: string | null } If Expression If Expression: { childName: string ; expression: string }
Type declaration child Name: string expression: string Index Field Index Field: { name: string ; sortDirection: string }
Type declaration name: string sort Direction: string Industries Manufacturing Settings Industries
Manufacturing
Settings
: Metadata & { enableIndManufacturing
?: boolean | null ; enableIndustriesMfgAccountForecast
?: boolean | null } Industries Settings Industries
Settings
: Metadata & { allowMultipleProducersToWorkOnSamePolicy
?: boolean | null ; enableAccessToMasterListOfCoverageTypes
?: boolean | null ; enableBlockResourceAvailabilityOrgPref
?: boolean | null ; enableEventManagementOrgPref
?: boolean | null ; enableHCReferralScoring
?: boolean | null ; enableManyToManyRelationships
?: boolean | null ; enableMortgageRlaTotalsOrgPref
?: boolean | null ; enableMultiResourceOrgPref
?: boolean | null ; enableObjectDetection
?: boolean | null ; enableOverbookingOrgPref
?: boolean | null ; enableProviderSearchSyncOrgPref
?: boolean | null ; enableReferralScoring
?: boolean | null ; enableSentimentAnalysis
?: boolean | null } Installed Package Installed
Package
: Metadata & { activateRSS
: boolean ; password
?: string | null ; versionNumber
: string } Integration Hub Settings Integration
Hub
Settings
: Metadata & { canonicalName
?: string | null ; canonicalNameBindingChar
?: string | null ; description
?: string | null ; isEnabled
?: boolean | null ; isProtected
?: boolean | null ; masterLabel
: string ; setupData
?: string | null ; setupDefinition
?: string | null ; setupNamespace
?: string | null ; setupSimpleName
: string ; uUID
?: string | null ; version
?: string | null ; versionBuild
?: number | null ; versionMajor
?: number | null ; versionMinor
?: number | null ; versionSetUuid
?: string | null } Integration Hub Settings Type Integration
Hub
Settings
Type
: Metadata & { canonicalName
?: string | null ; canonicalNameBindingChar
?: string | null ; description
?: string | null ; isEnabled
?: boolean | null ; isProtected
?: boolean | null ; masterLabel
: string ; setupNamespace
?: string | null ; setupSimpleName
: string ; uUID
?: string | null ; version
?: string | null ; versionBuild
?: number | null ; versionMajor
?: number | null ; versionMinor
?: number | null ; versionSetUuid
?: string | null } Invocable Action Settings Invocable
Action
Settings
: Metadata & { isPartialSaveAllowed
?: boolean | null } IoTSettings IoTSettings
: Metadata & { enableIoT
?: boolean | null ; enableIoTInsightsPilot
?: boolean | null ; enableIoTUsageEmail
?: boolean | null } Ip Range Ip Range: { description?: string | null ; end?: string | null ; start?: string | null }
Type declaration Optional description?: string | null Optional end?: string | null Optional start?: string | null Isv Hammer Settings Isv
Hammer
Settings
: Metadata & { enableIsvHammerSubIsOptedOut
?: boolean | null } Keyword Keyword: { keyword: string }
Keyword List Keyword
List
: Metadata & { description
?: string | null ; keywords
: Keyword [] ; masterLabel
: string } Knowledge Answer Settings Knowledge Answer Settings: { assignTo?: string | null ; defaultArticleType?: string | null ; enableArticleCreation?: boolean | null }
Type declaration Optional assign To?: string | null Optional default Article Type?: string | null Optional enable Article Creation?: boolean | null Knowledge Case Field Knowledge Case Field: { name?: string | null }
Type declaration Optional name?: string | null Knowledge Case Fields Settings Knowledge Case Settings Knowledge
Case
Settings
: { articlePDFCreationProfile
?: string | null ; articlePublicSharingCommunities
?: KnowledgeCommunitiesSettings | null ; articlePublicSharingSites
?: KnowledgeSitesSettings | null ; articlePublicSharingSitesChatterAnswers
?: KnowledgeSitesSettings | null ; assignTo
?: string | null ; customizationClass
?: string | null ; defaultContributionArticleType
?: string | null ; editor
?: string | null ; enableArticleCreation
?: boolean | null ; enableArticlePublicSharingSites
?: boolean | null ; enableCaseDataCategoryMapping
?: boolean | null ; useProfileForPDFCreation
?: boolean | null } Type declaration Optional articlePDFCreation Profile?: string | null Optional article Public Sharing Sites Chatter Answers?: KnowledgeSitesSettings | null Optional assign To?: string | null Optional customization Class?: string | null Optional default Contribution Article Type?: string | null Optional editor?: string | null Optional enable Article Creation?: boolean | null Optional enable Article Public Sharing Sites?: boolean | null Optional enable Case Data Category Mapping?: boolean | null Optional use Profile ForPDFCreation?: boolean | null Knowledge Communities Settings Knowledge Communities Settings: { community: string [] }
Knowledge Language Knowledge Language: { active?: boolean | null ; defaultAssignee?: string | null ; defaultAssigneeType?: string | null ; defaultReviewer?: string | null ; defaultReviewerType?: string | null ; name: string }
Type declaration Optional active?: boolean | null Optional default Assignee?: string | null Optional default Assignee Type?: string | null Optional default Reviewer?: string | null Optional default Reviewer Type?: string | null name: string Knowledge Language Settings Knowledge Settings Knowledge
Settings
: Metadata & { answers
?: KnowledgeAnswerSettings | null ; cases
?: KnowledgeCaseSettings | null ; defaultLanguage
?: string | null ; enableChatterQuestionKBDeflection
?: boolean | null ; enableCreateEditOnArticlesTab
?: boolean | null ; enableExternalMediaContent
?: boolean | null ; enableKnowledge
?: boolean | null ; enableKnowledgeArticleTextHighlights
?: boolean | null ; enableKnowledgeKeywordAutoComplete
?: boolean | null ; enableKnowledgeTitleAutoComplete
?: boolean | null ; enableLightningKbAutoLoadRichTextField
?: boolean | null ; enableLightningKnowledge
?: boolean | null ; languages
?: KnowledgeLanguageSettings | null ; showArticleSummariesCustomerPortal
?: boolean | null ; showArticleSummariesInternalApp
?: boolean | null ; showArticleSummariesPartnerPortal
?: boolean | null ; showValidationStatusField
?: boolean | null ; suggestedArticles
?: KnowledgeSuggestedArticlesSettings | null } Knowledge Sites Settings Knowledge Sites Settings: { site: string [] }
Knowledge Suggested Articles Settings Type declaration Optional use Suggested Articles For Case?: boolean | null Knowledge Work Order Field Knowledge Work Order Field: { name?: string | null }
Type declaration Optional name?: string | null Knowledge Work Order Fields Settings Knowledge Work Order Line Item Field Knowledge Work Order Line Item Field: { name?: string | null }
Type declaration Optional name?: string | null Knowledge Work Order Line Item Fields Settings Language Settings Language
Settings
: Metadata & { enableCanadaIcuFormat
?: boolean | null ; enableEndUserLanguages
?: boolean | null ; enableICULocaleDateFormat
?: boolean | null ; enablePlatformLanguages
?: boolean | null ; enableTranslationWorkbench
?: boolean | null ; useLanguageFallback
?: boolean | null } Layout Layout
: Metadata & { customButtons
: string [] ; customConsoleComponents
?: CustomConsoleComponents | null ; emailDefault
?: boolean | null ; excludeButtons
: string [] ; feedLayout
?: FeedLayout | null ; headers
: string [] ; layoutSections
: LayoutSection [] ; miniLayout
?: MiniLayout | null ; multilineLayoutFields
: string [] ; platformActionList
?: PlatformActionList | null ; quickActionList
?: QuickActionList | null ; relatedContent
?: RelatedContent | null ; relatedLists
: RelatedListItem [] ; relatedObjects
: string [] ; runAssignmentRulesDefault
?: boolean | null ; showEmailCheckbox
?: boolean | null ; showHighlightsPanel
?: boolean | null ; showInteractionLogPanel
?: boolean | null ; showKnowledgeComponent
?: boolean | null ; showRunAssignmentRulesCheckbox
?: boolean | null ; showSolutionSection
?: boolean | null ; showSubmitAndAttachButton
?: boolean | null ; summaryLayout
?: SummaryLayout | null } Layout Column Layout
Column
: { layoutItems
: LayoutItem [] ; reserved
?: string | null } Type declaration Optional reserved?: string | null Layout Item Layout
Item
: { analyticsCloudComponent
?: AnalyticsCloudComponentLayoutItem | null ; behavior
?: string | null ; canvas
?: string | null ; component
?: string | null ; customLink
?: string | null ; emptySpace
?: boolean | null ; field
?: string | null ; height
?: number | null ; page
?: string | null ; reportChartComponent
?: ReportChartComponentLayoutItem | null ; scontrol
?: string | null ; showLabel
?: boolean | null ; showScrollbars
?: boolean | null ; width
?: string | null } Type declaration Optional behavior?: string | null Optional canvas?: string | null Optional component?: string | null Optional custom Link?: string | null Optional empty Space?: boolean | null Optional field?: string | null Optional height?: number | null Optional page?: string | null Optional scontrol?: string | null Optional show Label?: boolean | null Optional show Scrollbars?: boolean | null Optional width?: string | null Layout Section Layout
Section
: { customLabel
?: boolean | null ; detailHeading
?: boolean | null ; editHeading
?: boolean | null ; label
?: string | null ; layoutColumns
: LayoutColumn [] ; style
: string } Type declaration Optional custom Label?: boolean | null Optional detail Heading?: boolean | null Optional edit Heading?: boolean | null Optional label?: string | null style: string Layout Section Translation Layout Section Translation: { label: string ; section: string }
Type declaration label: string section: string Layout Translation Type declaration layout: string Optional layout Type?: string | null Lead Config Settings Lead
Config
Settings
: Metadata & { doesEnableLeadConvertDefaultSubjectBlankTaskCreation
?: boolean | null ; doesHideOpportunityInConvertLeadWindow
?: boolean | null ; doesPreserveLeadStatus
?: boolean | null ; doesSelectNoOpportunityOnConvertLead
?: boolean | null ; doesTrackHistory
?: boolean | null ; enableConversionsOnMobile
?: boolean | null ; enableOrgWideMergeAndDelete
?: boolean | null ; shouldLeadConvertRequireValidation
?: boolean | null } Lead Convert Settings Lead
Convert
Settings
: Metadata & { allowOwnerChange
?: boolean | null ; objectMapping
: ObjectMapping [] ; opportunityCreationOptions
?: string | null } Letterhead Header Footer Letterhead Header Footer: { backgroundColor: string ; height: number ; horizontalAlignment?: string | null ; logo?: string | null ; verticalAlignment?: string | null }
Type declaration background Color: string height: number Optional horizontal Alignment?: string | null Optional logo?: string | null Optional vertical Alignment?: string | null Letterhead Line Letterhead Line: { color: string ; height: number }
Type declaration color: string height: number License Definition License
Definition
: Metadata & { aggregationGroup
: string ; description
?: string | null ; isPublished
: boolean ; label
: string ; licensedCustomPermissions
: LicensedCustomPermissions [] ; licensingAuthority
: string ; licensingAuthorityProvider
: string ; minPlatformVersion
: number ; origin
: string ; revision
: number ; trialLicenseDuration
: number ; trialLicenseQuantity
: number } Licensed Custom Permissions Licensed Custom Permissions: { customPermission: string ; licenseDefinition: string }
Type declaration custom Permission: string license Definition: string Lightning Bolt Features Lightning Bolt Features: { description?: string | null ; order: number ; title: string }
Type declaration Optional description?: string | null order: number title: string Lightning Bolt Images Lightning Bolt Images: { image: string ; order: number }
Type declaration image: string order: number Lightning Bolt Items Lightning Bolt Items: { name: string ; type: string }
Lightning Component Bundle Lightning
Component
Bundle
: Metadata & { apiVersion
?: number | null ; description
?: string | null ; isExplicitImport
?: boolean | null ; isExposed
?: boolean | null ; lwcResources
?: LwcResources | null ; masterLabel
?: string | null ; runtimeNamespace
?: string | null ; targetConfigs
?: string | null ; targets
?: Targets | null } Lightning Experience Settings Lightning
Experience
Settings
: Metadata & { enableAccessCheckCrucPref
?: boolean | null ; enableApiUserLtngOutAccessPref
?: boolean | null ; enableAuraCDNPref
?: boolean | null ; enableFeedbackInMobile
?: boolean | null ; enableIE11DeprecationMsgHidden
?: boolean | null ; enableIE11LEXCrucPref
?: boolean | null ; enableInAppTooltips
?: boolean | null ; enableLEXOnIpadEnabled
?: boolean | null ; enableLexEndUsersNoSwitching
?: boolean | null ; enableNavPersonalizationOptOut
?: boolean | null ; enableRemoveThemeBrandBanner
?: boolean | null ; enableS1BannerPref
?: boolean | null ; enableS1BrowserEnabled
?: boolean | null ; enableS1DesktopEnabled
?: boolean | null ; enableS1UiLoggingEnabled
?: boolean | null ; enableTryLightningOptOut
?: boolean | null ; enableUseS1AlohaDesktop
?: boolean | null ; enableUsersAreLightningOnly
?: boolean | null } Lightning Experience Theme Lightning
Experience
Theme
: Metadata & { defaultBrandingSet
: string ; description
?: string | null ; masterLabel
: string ; shouldOverrideLoadingImage
?: boolean | null } Lightning Message Channel Lightning
Message
Channel
: Metadata & { description
?: string | null ; isExposed
?: boolean | null ; lightningMessageFields
: LightningMessageField [] ; masterLabel
: string } Lightning Message Field Lightning Message Field: { description?: string | null ; fieldName: string }
Type declaration Optional description?: string | null field Name: string Lightning Onboarding Config Lightning
Onboarding
Config
: Metadata & { collaborationGroup
?: string | null ; customQuestion
: string ; feedbackFormDaysFrequency
: number ; isCustom
: boolean ; masterLabel
: string ; sendFeedbackToSalesforce
: boolean } List Metadata Query List Metadata Query: { folder?: string | null ; type: string }
Type declaration Optional folder?: string | null type: string List Placement List Placement: { height?: number | null ; location: string ; units?: string | null ; width?: number | null }
Type declaration Optional height?: number | null location: string Optional units?: string | null Optional width?: number | null List View List
View
: Metadata & { booleanFilter
?: string | null ; columns
: string [] ; division
?: string | null ; filterScope
: string ; filters
: ListViewFilter [] ; label
: string ; language
?: string | null ; queue
?: string | null ; sharedTo
?: SharedTo | null } List View Filter List View Filter: { field: string ; operation: string ; value?: string | null }
Type declaration field: string operation: string Optional value?: string | null Live Agent Config Live Agent Config: { enableLiveChat?: boolean | null ; openNewAccountSubtab?: boolean | null ; openNewCaseSubtab?: boolean | null ; openNewContactSubtab?: boolean | null ; openNewLeadSubtab?: boolean | null ; openNewVFPageSubtab?: boolean | null ; pageNamesToOpen: string [] ; showKnowledgeArticles?: boolean | null }
Type declaration Optional enable Live Chat?: boolean | null Optional open New Account Subtab?: boolean | null Optional open New Case Subtab?: boolean | null Optional open New Contact Subtab?: boolean | null Optional open New Lead Subtab?: boolean | null Optional open NewVFPage Subtab?: boolean | null page Names To Open: string [] Optional show Knowledge Articles?: boolean | null Live Agent Settings Live
Agent
Settings
: Metadata & { enableLiveAgent
?: boolean | null ; enableQuickTextEnabled
?: boolean | null } Live Chat Agent Config Live
Chat
Agent
Config
: Metadata & { assignments
?: AgentConfigAssignments | null ; autoGreeting
?: string | null ; capacity
?: number | null ; criticalWaitTime
?: number | null ; customAgentName
?: string | null ; enableAgentFileTransfer
?: boolean | null ; enableAgentSneakPeek
?: boolean | null ; enableAssistanceFlag
?: boolean | null ; enableAutoAwayOnDecline
?: boolean | null ; enableAutoAwayOnPushTimeout
?: boolean | null ; enableChatConferencing
?: boolean | null ; enableChatMonitoring
?: boolean | null ; enableChatTransferToAgent
?: boolean | null ; enableChatTransferToButton
?: boolean | null ; enableChatTransferToSkill
?: boolean | null ; enableLogoutSound
?: boolean | null ; enableNotifications
?: boolean | null ; enableRequestSound
?: boolean | null ; enableSneakPeek
?: boolean | null ; enableVisitorBlocking
?: boolean | null ; enableWhisperMessage
?: boolean | null ; label
: string ; supervisorDefaultAgentStatusFilter
?: string | null ; supervisorDefaultButtonFilter
?: string | null ; supervisorDefaultSkillFilter
?: string | null ; supervisorSkills
?: SupervisorAgentConfigSkills | null ; transferableButtons
?: AgentConfigButtons | null ; transferableSkills
?: AgentConfigSkills | null } Live Chat Button Live
Chat
Button
: Metadata & { animation
?: string | null ; autoGreeting
?: string | null ; chasitorIdleTimeout
?: number | null ; chasitorIdleTimeoutWarning
?: number | null ; chatPage
?: string | null ; customAgentName
?: string | null ; deployments
?: LiveChatButtonDeployments | null ; enableQueue
?: boolean | null ; inviteEndPosition
?: string | null ; inviteImage
?: string | null ; inviteStartPosition
?: string | null ; isActive
?: boolean | null ; label
: string ; numberOfReroutingAttempts
?: number | null ; offlineImage
?: string | null ; onlineImage
?: string | null ; optionsCustomRoutingIsEnabled
?: boolean | null ; optionsHasChasitorIdleTimeout
: boolean ; optionsHasInviteAfterAccept
?: boolean | null ; optionsHasInviteAfterReject
?: boolean | null ; optionsHasRerouteDeclinedRequest
?: boolean | null ; optionsIsAutoAccept
?: boolean | null ; optionsIsInviteAutoRemove
?: boolean | null ; overallQueueLength
?: number | null ; perAgentQueueLength
?: number | null ; postChatPage
?: string | null ; postChatUrl
?: string | null ; preChatFormPage
?: string | null ; preChatFormUrl
?: string | null ; pushTimeOut
?: number | null ; routingType
: string ; site
?: string | null ; skills
?: LiveChatButtonSkills | null ; timeToRemoveInvite
?: number | null ; type
: string ; windowLanguage
?: string | null } Live Chat Button Deployments Live Chat Button Deployments: { deployment: string [] }
Live Chat Button Skills Live Chat Button Skills: { skill: string [] }
Live Chat Deployment Live
Chat
Deployment
: Metadata & { brandingImage
?: string | null ; connectionTimeoutDuration
?: number | null ; connectionWarningDuration
?: number | null ; displayQueuePosition
?: boolean | null ; domainWhiteList
?: LiveChatDeploymentDomainWhitelist | null ; enablePrechatApi
?: boolean | null ; enableTranscriptSave
?: boolean | null ; label
: string ; mobileBrandingImage
?: string | null ; site
?: string | null ; windowTitle
: string } Live Chat Deployment Domain Whitelist Live Chat Deployment Domain Whitelist: { domain: string [] }
Live Chat Sensitive Data Rule Live
Chat
Sensitive
Data
Rule
: Metadata & { actionType
: string ; description
?: string | null ; enforceOn
: number ; isEnabled
: boolean ; pattern
: string ; priority
: number ; replacement
?: string | null } Live Message Settings Live
Message
Settings
: Metadata & { enableLiveMessage
?: boolean | null } Local Ml Domain Local
Ml
Domain
: { label
: string ; mlIntents
: MlIntent [] ; mlSlotClasses
: MlSlotClass [] ; name
: string } Type declaration label: string name: string Log Info Log Info: { category: string ; level: string }
Type declaration category: string level: string Lookup Filter Lookup
Filter
: { active
: boolean ; booleanFilter
?: string | null ; description
?: string | null ; errorMessage
?: string | null ; filterItems
: FilterItem [] ; infoMessage
?: string | null ; isOptional
: boolean } Type declaration active: boolean Optional boolean Filter?: string | null Optional description?: string | null Optional error Message?: string | null Optional info Message?: string | null is Optional: boolean Lookup Filter Translation Lookup Filter Translation: { errorMessage: string ; informationalMessage: string }
Type declaration error Message: string informational Message: string Lwc Resource Lwc Resource: { filePath: string ; source: string }
Type declaration file Path: string source: string Macro Settings Macro
Settings
: Metadata & { enableAdvancedSearch
?: boolean | null ; macrosInFolders
?: boolean | null } Managed Content Node Type Managed Content Node Type: { helpText?: string | null ; isLocalizable?: boolean | null ; isRequired?: boolean | null ; nodeLabel: string ; nodeName: string ; nodeType: string ; placeholderText?: string | null }
Type declaration Optional help Text?: string | null Optional is Localizable?: boolean | null Optional is Required?: boolean | null node Label: string node Name: string node Type: string Optional placeholder Text?: string | null Managed Content Type Managed
Content
Type
: Metadata & { description
?: string | null ; developerName
: string ; managedContentNodeTypes
: ManagedContentNodeType [] ; masterLabel
: string } Managed Topic Managed
Topic
: Metadata & { managedTopicType
: string ; name
: string ; parentName
: string ; position
: number ; topicDescription
: string } Map Expression Map Expression: { expression: string ; name: string ; type: string }
Type declaration expression: string name: string type: string Maps And Location Settings Maps
And
Location
Settings
: Metadata & { enableAddressAutoComplete
?: boolean | null ; enableMapsAndLocation
?: boolean | null } Matching Rule Matching
Rule
: Metadata & { booleanFilter
?: string | null ; description
?: string | null ; label
: string ; matchingRuleItems
: MatchingRuleItem [] ; ruleStatus
: string } Matching Rule Item Matching Rule Item: { blankValueBehavior?: string | null ; fieldName: string ; matchingMethod: string }
Type declaration Optional blank Value Behavior?: string | null field Name: string matching Method: string Metadata Metadata: { fullName?: string | null }
Type declaration Optional full Name?: string | null Metadata With Content Metadata
With
Content
: Metadata & { content
?: string | null } Milestone Type Milestone
Type
: Metadata & { description
?: string | null ; recurrenceType
?: string | null } Ml Intent Type declaration Optional description?: string | null developer Name: string label: string Ml Intent Utterance Ml Intent Utterance: { utterance: string }
Ml Related Intent Ml Related Intent: { relatedMlIntent: string }
Ml Slot Class Ml
Slot
Class
: { dataType
: string ; description
?: string | null ; developerName
: string ; extractionRegex
?: string | null ; extractionType
?: string | null ; label
: string ; mlSlotClassValues
: MlSlotClassValue [] } Type declaration data Type: string Optional description?: string | null developer Name: string Optional extraction Regex?: string | null Optional extraction Type?: string | null label: string Ml Slot Class Value Ml
Slot
Class
Value
: { synonymGroup
?: SynonymGroup | null ; value
: string } Mobile Application Detail Mobile
Application
Detail
: Metadata & { applicationBinaryFile
?: string | null ; applicationBinaryFileName
?: string | null ; applicationBundleIdentifier
?: string | null ; applicationFileLength
?: number | null ; applicationIconFile
?: string | null ; applicationIconFileName
?: string | null ; applicationInstallUrl
?: string | null ; devicePlatform
: string ; deviceType
?: string | null ; minimumOsVersion
?: string | null ; privateApp
?: boolean | null ; version
: string } Mobile Settings Mobile
Settings
: Metadata & { dashboardMobile
?: DashboardMobileSettings | null ; enableImportContactFromDevice
?: boolean | null ; enableLightningOnMobile
?: boolean | null ; enableOfflineDraftsEnabled
?: boolean | null ; enablePopulateNameManuallyInToday
?: boolean | null ; enableS1EncryptedStoragePref2
?: boolean | null ; enableS1OfflinePref
?: boolean | null } Moderated Entity Field Moderated Entity Field: { entityName: string ; fieldName?: string | null ; keywordList?: string | null }
Type declaration entity Name: string Optional field Name?: string | null Optional keyword List?: string | null Moderation Rule Moderation
Rule
: Metadata & { action
: string ; actionLimit
?: number | null ; active
: boolean ; description
?: string | null ; entitiesAndFields
: ModeratedEntityField [] ; masterLabel
: string ; notifyLimit
?: number | null ; timePeriod
?: string | null ; type
?: string | null ; userCriteria
: string [] ; userMessage
?: string | null } My Domain Settings My
Domain
Settings
: Metadata & { canOnlyLoginWithMyDomainUrl
?: boolean | null ; doesApiLoginRequireOrgDomain
?: boolean | null ; enableNativeBrowserForAuthOnAndroid
?: boolean | null ; enableNativeBrowserForAuthOnIos
?: boolean | null ; useStabilizedMyDomainHostnames
?: boolean | null ; useStabilizedSandboxMyDomainHostnames
?: boolean | null } Name Settings Name
Settings
: Metadata & { enableMiddleName
?: boolean | null ; enableNameSuffix
?: boolean | null } Named Credential Named
Credential
: Metadata & { allowMergeFieldsInBody
?: boolean | null ; allowMergeFieldsInHeader
?: boolean | null ; authProvider
?: string | null ; authTokenEndpointUrl
?: string | null ; awsAccessKey
?: string | null ; awsAccessSecret
?: string | null ; awsRegion
?: string | null ; awsService
?: string | null ; certificate
?: string | null ; endpoint
?: string | null ; generateAuthorizationHeader
?: boolean | null ; jwtAudience
?: string | null ; jwtFormulaSubject
?: string | null ; jwtIssuer
?: string | null ; jwtSigningCertificate
?: string | null ; jwtTextSubject
?: string | null ; jwtValidityPeriodSeconds
?: number | null ; label
: string ; oauthRefreshToken
?: string | null ; oauthScope
?: string | null ; oauthToken
?: string | null ; password
?: string | null ; principalType
: string ; privateConnection
?: string | null ; protocol
: string ; username
?: string | null } Navigation Menu Item Navigation
Menu
Item
: { defaultListViewId
?: string | null ; label
: string ; menuItemBranding
?: NavigationMenuItemBranding | null ; position
: number ; publiclyAvailable
?: boolean | null ; subMenu
?: NavigationSubMenu | null ; target
?: string | null ; targetPreference
?: string | null ; type
: string } Type declaration Optional default List View Id?: string | null label: string position: number Optional publicly Available?: boolean | null Optional target?: string | null Optional target Preference?: string | null type: string Navigation Menu Item Branding Navigation Menu Item Branding: { tileImage?: string | null }
Type declaration Optional tile Image?: string | null Network Network
: Metadata & { allowInternalUserLogin
?: boolean | null ; allowMembersToFlag
?: boolean | null ; allowedExtensions
?: string | null ; caseCommentEmailTemplate
?: string | null ; changePasswordTemplate
: string ; communityRoles
?: CommunityRoles | null ; description
?: string | null ; disableReputationRecordConversations
?: boolean | null ; emailFooterLogo
?: string | null ; emailFooterText
?: string | null ; emailSenderAddress
: string ; emailSenderName
: string ; enableCustomVFErrorPageOverrides
?: boolean | null ; enableDirectMessages
?: boolean | null ; enableGuestChatter
?: boolean | null ; enableGuestFileAccess
?: boolean | null ; enableGuestMemberVisibility
?: boolean | null ; enableInvitation
?: boolean | null ; enableKnowledgeable
?: boolean | null ; enableMemberVisibility
?: boolean | null ; enableNicknameDisplay
?: boolean | null ; enablePrivateMessages
?: boolean | null ; enableReputation
?: boolean | null ; enableShowAllNetworkSettings
?: boolean | null ; enableSiteAsContainer
?: boolean | null ; enableTalkingAboutStats
?: boolean | null ; enableTopicAssignmentRules
?: boolean | null ; enableTopicSuggestions
?: boolean | null ; enableUpDownVote
?: boolean | null ; feedChannel
?: string | null ; forgotPasswordTemplate
: string ; gatherCustomerSentimentData
?: boolean | null ; lockoutTemplate
?: string | null ; logoutUrl
?: string | null ; maxFileSizeKb
?: number | null ; navigationLinkSet
?: NavigationLinkSet | null ; networkMemberGroups
?: NetworkMemberGroup | null ; networkPageOverrides
?: NetworkPageOverride | null ; newSenderAddress
?: string | null ; picassoSite
?: string | null ; recommendationAudience
?: RecommendationAudience | null ; recommendationDefinition
?: RecommendationDefinition | null ; reputationLevels
?: ReputationLevelDefinitions | null ; reputationPointsRules
?: ReputationPointsRules | null ; selfRegProfile
?: string | null ; selfRegistration
?: boolean | null ; sendWelcomeEmail
?: boolean | null ; site
: string ; status
: string ; tabs
: NetworkTabSet ; urlPathPrefix
?: string | null ; verificationTemplate
?: string | null ; welcomeTemplate
: string } Network Access Network
Access
: { ipRanges
: IpRange [] } Network Branding Network
Branding
: MetadataWithContent & { loginBackgroundImageUrl
?: string | null ; loginFooterText
?: string | null ; loginLogo
?: string | null ; loginLogoName
?: string | null ; loginPrimaryColor
?: string | null ; loginQuaternaryColor
?: string | null ; loginRightFrameUrl
?: string | null ; network
?: string | null ; pageFooter
?: string | null ; pageHeader
?: string | null ; primaryColor
: string ; primaryComplementColor
: string ; quaternaryColor
: string ; quaternaryComplementColor
: string ; secondaryColor
: string ; staticLogoImageUrl
?: string | null ; tertiaryColor
: string ; tertiaryComplementColor
: string ; zeronaryColor
: string ; zeronaryComplementColor
: string } Network Member Group Network Member Group: { permissionSet: string [] ; profile: string [] }
Type declaration permission Set: string [] profile: string [] Network Page Override Network Page Override: { changePasswordPageOverrideSetting?: string | null ; forgotPasswordPageOverrideSetting?: string | null ; homePageOverrideSetting?: string | null ; loginPageOverrideSetting?: string | null ; selfRegProfilePageOverrideSetting?: string | null }
Type declaration Optional change Password Page Override Setting?: string | null Optional forgot Password Page Override Setting?: string | null Optional home Page Override Setting?: string | null Optional login Page Override Setting?: string | null Optional self Reg Profile Page Override Setting?: string | null Network Tab Set Network Tab Set: { customTab: string [] ; defaultTab: string ; standardTab: string [] }
Type declaration custom Tab: string [] default Tab: string standard Tab: string [] Next Automated Approver Next Automated Approver: { useApproverFieldOfRecordOwner?: boolean | null ; userHierarchyField: string }
Type declaration Optional use Approver Field Of Record Owner?: boolean | null user Hierarchy Field: string Notifications Settings Notifications
Settings
: Metadata & { enableMobileAppPushNotifications
?: boolean | null ; enableNotifications
?: boolean | null } Oauth Custom Scope Oauth
Custom
Scope
: Metadata & { description
: string ; developerName
: string ; isProtected
?: boolean | null ; isPublic
?: boolean | null ; masterLabel
: string } Object Linking Settings Object
Linking
Settings
: Metadata & { enableObjectLinking
?: boolean | null } Object Mapping Object
Mapping
: { inputObject
: string ; mappingFields
: ObjectMappingField [] ; outputObject
: string } Type declaration input Object: string output Object: string Object Mapping Field Object Mapping Field: { inputField: string ; outputField: string }
Type declaration input Field: string output Field: string Object Name Case Value Object Name Case Value: { article?: string | null ; caseType?: string | null ; plural?: boolean | null ; possessive?: string | null ; value: string }
Type declaration Optional article?: string | null Optional case Type?: string | null Optional plural?: boolean | null Optional possessive?: string | null value: string Object Relationship Object
Relationship
: { join
?: ObjectRelationship | null ; outerJoin
: boolean ; relationship
: string } Type declaration outer Join: boolean relationship: string Object Search Setting Object Search Setting: { enhancedLookupEnabled: boolean ; lookupAutoCompleteEnabled: boolean ; name: string ; resultsPerPageCount: number }
Type declaration enhanced Lookup Enabled: boolean lookup Auto Complete Enabled: boolean name: string results Per Page Count: number Object Usage Object Usage: { object: string [] }
Omni Channel Settings Omni
Channel
Settings
: Metadata & { enableOmniAutoLoginPrompt
?: boolean | null ; enableOmniChannel
?: boolean | null ; enableOmniSecondaryRoutingPriority
?: boolean | null ; enableOmniSkillsRouting
?: boolean | null } Opportunity List Fields Label Mapping Opportunity List Fields Label Mapping: { field: string ; label: string }
Type declaration field: string label: string Opportunity List Fields Selected Settings Opportunity List Fields Selected Settings: { field: string [] }
Opportunity List Fields Unselected Settings Opportunity List Fields Unselected Settings: { field: string [] }
Opportunity Settings Opportunity
Settings
: Metadata & { autoActivateNewReminders
?: boolean | null ; customizableProductSchedulesEnabled
?: boolean | null ; doesAutoAddSplitOwnerAsOpportunityTeamMember
?: boolean | null ; doesEnforceStandardOpportunitySaveLogic
?: boolean | null ; enableFindSimilarOpportunities
?: boolean | null ; enableOpportunityFieldHistoryTracking
?: boolean | null ; enableOpportunityInsightsInMobile
?: boolean | null ; enableOpportunityTeam
?: boolean | null ; enableUpdateReminders
?: boolean | null ; findSimilarOppFilter
?: FindSimilarOppFilter | null ; promptToAddProducts
?: boolean | null } Orchestration Context Orchestration
Context
: Metadata & { datasets
: OrchestrationContextDataset [] ; description
?: string | null ; events
: OrchestrationContextEvent [] ; imageFile
: string ; imageScale
: number ; masterLabel
: string ; runtimeType
: string ; salesforceObject
?: string | null ; salesforceObjectPrimaryKey
?: string | null } Orchestration Context Dataset Orchestration Context Dataset: { datasetType: string ; orchestrationDataset: string }
Type declaration dataset Type: string orchestration Dataset: string Orchestration Context Event Orchestration Context Event: { eventType: string ; orchestrationEvent: string ; platformEvent: string ; platformEventPrimaryKey: string }
Type declaration event Type: string orchestration Event: string platform Event: string platform Event Primary Key: string Order Management Settings Order
Management
Settings
: Metadata & { enableOrderManagement
?: boolean | null } Order Settings Order
Settings
: Metadata & { enableNegativeQuantity
?: boolean | null ; enableOrders
?: boolean | null ; enableReductionOrders
?: boolean | null ; enableZeroQuantity
?: boolean | null } Org Settings Org
Settings
: Metadata & { enableCustomerSuccessPortal
?: boolean | null ; enableExtendedMailMerge
?: boolean | null ; enableIncludeContractStatus
?: boolean | null ; enableMakeDeploymentsMandatory
?: boolean | null ; enableManageSelfServiceUsers
?: boolean | null ; enableOrgFeedSentimentAnalysis
?: boolean | null ; enableRADeploymentAttributeOnly
?: boolean | null ; enableResetDivisionOnLogin
?: boolean | null ; saveMailMergeDocsAsSalesforceDocs
?: boolean | null } Organization Settings Detail Organization Settings Detail: { settingName: string ; settingValue: boolean }
Type declaration setting Name: string setting Value: boolean Package Package
: Metadata & { apiAccessLevel
?: string | null ; description
?: string | null ; namespacePrefix
?: string | null ; objectPermissions
: ProfileObjectPermissions [] ; packageType
?: string | null ; postInstallClass
?: string | null ; setupWeblink
?: string | null ; types
: PackageTypeMembers [] ; uninstallClass
?: string | null ; version
: string } Package Type Members Package Type Members: { members: string [] ; name: string }
Type declaration members: string [] name: string Package Version Package Version: { majorNumber: number ; minorNumber: number ; namespace: string }
Type declaration major Number: number minor Number: number namespace: string Pardot Einstein Settings Pardot
Einstein
Settings
: Metadata & { enableCampaignInsight
?: boolean | null ; enableEngagementScore
?: boolean | null } Pardot Settings Pardot
Settings
: Metadata & { enableB2bmaAppEnabled
?: boolean | null ; enableEngagementHistoryDashboards
?: boolean | null ; enablePardotAppV1Enabled
?: boolean | null ; enablePardotEnabled
?: boolean | null ; enableProspectActivityDataset
?: boolean | null } Party Data Model Settings Party
Data
Model
Settings
: Metadata & { enableAutoSelectIndividualOnMerge
?: boolean | null ; enableConsentManagement
?: boolean | null } Password Policies Password Policies: { apiOnlyUserHomePageURL?: string | null ; complexity?: string | null ; enableSetPasswordInApi?: boolean | null ; expiration?: string | null ; historyRestriction?: string | null ; lockoutInterval?: string | null ; maxLoginAttempts?: string | null ; minimumPasswordLength?: string | null ; minimumPasswordLifetime?: boolean | null ; obscureSecretAnswer?: boolean | null ; passwordAssistanceMessage?: string | null ; passwordAssistanceURL?: string | null ; questionRestriction?: string | null }
Type declaration Optional api Only User Home PageURL?: string | null Optional complexity?: string | null Optional enable Set Password In Api?: boolean | null Optional expiration?: string | null Optional history Restriction?: string | null Optional lockout Interval?: string | null Optional max Login Attempts?: string | null Optional minimum Password Length?: string | null Optional minimum Password Lifetime?: boolean | null Optional obscure Secret Answer?: boolean | null Optional password Assistance Message?: string | null Optional password AssistanceURL?: string | null Optional question Restriction?: string | null Path Assistant Path
Assistant
: Metadata & { active
: boolean ; entityName
: string ; fieldName
: string ; masterLabel
: string ; pathAssistantSteps
: PathAssistantStep [] ; recordTypeName
: string } Path Assistant Settings Path
Assistant
Settings
: Metadata & { canOverrideAutoPathCollapseWithUserPref
?: boolean | null ; pathAssistantEnabled
?: boolean | null } Path Assistant Step Path Assistant Step: { fieldNames: string [] ; info?: string | null ; picklistValueName: string }
Type declaration field Names: string [] Optional info?: string | null picklist Value Name: string Permission Set Apex Class Access Permission Set Apex Class Access: { apexClass: string ; enabled: boolean }
Type declaration apex Class: string enabled: boolean Permission Set Apex Page Access Permission Set Apex Page Access: { apexPage: string ; enabled: boolean }
Type declaration apex Page: string enabled: boolean Permission Set Application Visibility Permission Set Application Visibility: { application: string ; visible: boolean }
Type declaration application: string visible: boolean Permission Set Custom Metadata Type Access Permission Set Custom Metadata Type Access: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Permission Set Custom Permissions Permission Set Custom Permissions: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Permission Set External Data Source Access Permission Set External Data Source Access: { enabled: boolean ; externalDataSource: string }
Type declaration enabled: boolean external Data Source: string Permission Set Field Permissions Permission Set Field Permissions: { editable: boolean ; field: string ; readable?: boolean | null }
Type declaration editable: boolean field: string Optional readable?: boolean | null Permission Set Flow Access Permission Set Flow Access: { enabled: boolean ; flow: string }
Type declaration enabled: boolean flow: string Permission Set Group Permission
Set
Group
: Metadata & { description
?: string | null ; label
: string ; mutingPermissionSets
: string [] ; permissionSets
: string [] ; status
?: string | null } Permission Set Object Permissions Permission Set Object Permissions: { allowCreate: boolean ; allowDelete: boolean ; allowEdit: boolean ; allowRead: boolean ; modifyAllRecords: boolean ; object: string ; viewAllRecords: boolean }
Type declaration allow Create: boolean allow Delete: boolean allow Edit: boolean allow Read: boolean modify All Records: boolean object: string view All Records: boolean Permission Set Record Type Visibility Permission Set Record Type Visibility: { recordType: string ; visible: boolean }
Type declaration record Type: string visible: boolean Permission Set Tab Setting Permission Set Tab Setting: { tab: string ; visibility: string }
Type declaration tab: string visibility: string Permission Set User Permission Permission Set User Permission: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Person List Settings Person
List
Settings
: Metadata & { enablePersonList
: boolean } Personalization Target Info Personalization Target Info: { groupName: string ; priority?: number | null ; targetType: string ; targetValue: string }
Type declaration group Name: string Optional priority?: number | null target Type: string target Value: string Personalization Target Infos Picklist Entry Picklist Entry: { active: boolean ; defaultValue: boolean ; label: string ; validFor?: string | null ; value: string }
Type declaration active: boolean default Value: boolean label: string Optional valid For?: string | null value: string Picklist Settings Picklist
Settings
: Metadata & { isPicklistApiNameEditDisabled
?: boolean | null } Picklist Value Picklist
Value
: Metadata & { allowEmail
?: boolean | null ; closed
?: boolean | null ; color
?: string | null ; controllingFieldValues
: string [] ; converted
?: boolean | null ; cssExposed
?: boolean | null ; default
: boolean ; description
?: string | null ; forecastCategory
?: string | null ; highPriority
?: boolean | null ; isActive
?: boolean | null ; probability
?: number | null ; reverseRole
?: string | null ; reviewed
?: boolean | null ; won
?: boolean | null } Picklist Value Translation Picklist Value Translation: { masterLabel: string ; translation?: string | null }
Type declaration master Label: string Optional translation?: string | null Platform Action List Item Platform Action List Item: { actionName: string ; actionType: string ; sortOrder: number ; subtype?: string | null }
Type declaration action Name: string action Type: string sort Order: number Optional subtype?: string | null Platform Cache Partition Platform
Cache
Partition
: Metadata & { description
?: string | null ; isDefaultPartition
: boolean ; masterLabel
: string ; platformCachePartitionTypes
: PlatformCachePartitionType [] } Platform Cache Partition Type Platform Cache Partition Type: { allocatedCapacity: number ; allocatedPurchasedCapacity: number ; allocatedTrialCapacity: number ; cacheType: string }
Type declaration allocated Capacity: number allocated Purchased Capacity: number allocated Trial Capacity: number cache Type: string Platform Encryption Settings Platform
Encryption
Settings
: Metadata & { canEncryptManagedPackageFields
?: boolean | null ; enableDeterministicEncryption
?: boolean | null ; enableEncryptFieldHistory
?: boolean | null ; enableEventBusEncryption
?: boolean | null ; isMEKForEncryptionRequired
?: boolean | null ; isUseHighAssuranceKeysRequired
?: boolean | null } Platform Event Channel Platform
Event
Channel
: Metadata & { channelType
: string ; label
: string } Platform Event Channel Member Platform
Event
Channel
Member
: Metadata & { eventChannel
: string ; selectedEntity
: string } Portal Portal
: Metadata & { active
: boolean ; admin
?: string | null ; defaultLanguage
?: string | null ; description
?: string | null ; emailSenderAddress
: string ; emailSenderName
: string ; enableSelfCloseCase
?: boolean | null ; footerDocument
?: string | null ; forgotPassTemplate
?: string | null ; headerDocument
?: string | null ; isSelfRegistrationActivated
?: boolean | null ; loginHeaderDocument
?: string | null ; logoDocument
?: string | null ; logoutUrl
?: string | null ; newCommentTemplate
?: string | null ; newPassTemplate
?: string | null ; newUserTemplate
?: string | null ; ownerNotifyTemplate
?: string | null ; selfRegNewUserUrl
?: string | null ; selfRegUserDefaultProfile
?: string | null ; selfRegUserDefaultRole
?: string | null ; selfRegUserTemplate
?: string | null ; showActionConfirmation
?: boolean | null ; stylesheetDocument
?: string | null ; type
: string } Post Template Post
Template
: Metadata & { default
?: boolean | null ; description
?: string | null ; fields
: string [] ; label
: string } Presence Config Assignments Presence Config Profile Assignments Presence Config Profile Assignments: { profile: string [] }
Presence Config User Assignments Presence Config User Assignments: { user: string [] }
Presence Decline Reason Presence
Decline
Reason
: Metadata & { label
: string } Presence User Config Presence
User
Config
: Metadata & { assignments
?: PresenceConfigAssignments | null ; capacity
: number ; declineReasons
: string [] ; enableAutoAccept
?: boolean | null ; enableDecline
?: boolean | null ; enableDeclineReason
?: boolean | null ; enableDisconnectSound
?: boolean | null ; enableRequestSound
?: boolean | null ; label
: string ; presenceStatusOnDecline
?: string | null ; presenceStatusOnPushTimeout
?: string | null } Primary Tab Components Primary
Tab
Components
: { containers
: Container [] } Privacy Settings Privacy
Settings
: Metadata & { enableConsentAuditTrail
?: boolean | null ; enableConsentEventStream
?: boolean | null ; enableDefaultMetadataValues
?: boolean | null } Private Connection Private
Connection
: Metadata & { description
?: string | null ; direction
: string ; externalConnectionProperties
: ExternalConnectionProperty [] ; label
: string ; status
: string ; type
: string } Product Settings Product
Settings
: Metadata & { enableCascadeActivateToRelatedPrices
?: boolean | null ; enableMySettings
?: boolean | null ; enableQuantitySchedule
?: boolean | null ; enableRevenueSchedule
?: boolean | null } Profile Action Override Profile Action Override: { actionName: string ; content?: string | null ; formFactor: string ; pageOrSobjectType: string ; recordType?: string | null ; type: string }
Type declaration action Name: string Optional content?: string | null form Factor: string page Or Sobject Type: string Optional record Type?: string | null type: string Profile Apex Class Access Profile Apex Class Access: { apexClass: string ; enabled: boolean }
Type declaration apex Class: string enabled: boolean Profile Apex Page Access Profile Apex Page Access: { apexPage: string ; enabled: boolean }
Type declaration apex Page: string enabled: boolean Profile Application Visibility Profile Application Visibility: { application: string ; default: boolean ; visible: boolean }
Type declaration application: string default: boolean visible: boolean Profile Category Group Visibility Profile Category Group Visibility: { dataCategories: string [] ; dataCategoryGroup: string ; visibility: string }
Type declaration data Categories: string [] data Category Group: string visibility: string Profile Custom Metadata Type Access Profile Custom Metadata Type Access: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Profile Custom Permissions Profile Custom Permissions: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Profile External Data Source Access Profile External Data Source Access: { enabled: boolean ; externalDataSource: string }
Type declaration enabled: boolean external Data Source: string Profile Field Level Security Profile Field Level Security: { editable: boolean ; field: string ; readable?: boolean | null }
Type declaration editable: boolean field: string Optional readable?: boolean | null Profile Flow Access Profile Flow Access: { enabled: boolean ; flow: string }
Type declaration enabled: boolean flow: string Profile Layout Assignment Profile Layout Assignment: { layout: string ; recordType?: string | null }
Type declaration layout: string Optional record Type?: string | null Profile Login Hours Profile Login Hours: { fridayEnd?: string | null ; fridayStart?: string | null ; mondayEnd?: string | null ; mondayStart?: string | null ; saturdayEnd?: string | null ; saturdayStart?: string | null ; sundayEnd?: string | null ; sundayStart?: string | null ; thursdayEnd?: string | null ; thursdayStart?: string | null ; tuesdayEnd?: string | null ; tuesdayStart?: string | null ; wednesdayEnd?: string | null ; wednesdayStart?: string | null }
Type declaration Optional friday End?: string | null Optional friday Start?: string | null Optional monday End?: string | null Optional monday Start?: string | null Optional saturday End?: string | null Optional saturday Start?: string | null Optional sunday End?: string | null Optional sunday Start?: string | null Optional thursday End?: string | null Optional thursday Start?: string | null Optional tuesday End?: string | null Optional tuesday Start?: string | null Optional wednesday End?: string | null Optional wednesday Start?: string | null Profile Login Ip Range Profile Login Ip Range: { description?: string | null ; endAddress: string ; startAddress: string }
Type declaration Optional description?: string | null end Address: string start Address: string Profile Object Permissions Profile Object Permissions: { allowCreate?: boolean | null ; allowDelete?: boolean | null ; allowEdit?: boolean | null ; allowRead?: boolean | null ; modifyAllRecords?: boolean | null ; object: string ; viewAllRecords?: boolean | null }
Type declaration Optional allow Create?: boolean | null Optional allow Delete?: boolean | null Optional allow Edit?: boolean | null Optional allow Read?: boolean | null Optional modify All Records?: boolean | null object: string Optional view All Records?: boolean | null Profile Password Policy Profile
Password
Policy
: Metadata & { forgotPasswordRedirect
?: boolean | null ; lockoutInterval
: number ; maxLoginAttempts
: number ; minimumPasswordLength
: number ; minimumPasswordLifetime
?: boolean | null ; obscure
?: boolean | null ; passwordComplexity
: number ; passwordExpiration
: number ; passwordHistory
: number ; passwordQuestion
: number ; profile
: string } Profile Record Type Visibility Profile Record Type Visibility: { default: boolean ; personAccountDefault?: boolean | null ; recordType: string ; visible: boolean }
Type declaration default: boolean Optional person Account Default?: boolean | null record Type: string visible: boolean Profile Search Layouts Profile Search Layouts: { fields: string [] ; profileName?: string | null }
Type declaration fields: string [] Optional profile Name?: string | null Profile Session Setting Profile
Session
Setting
: Metadata & { externalCommunityUserIdentityVerif
: boolean ; forceLogout
: boolean ; profile
: string ; requiredSessionLevel
?: string | null ; sessionPersistence
: boolean ; sessionTimeout
: number ; sessionTimeoutWarning
: boolean } Profile Tab Visibility Profile Tab Visibility: { tab: string ; visibility: string }
Type declaration tab: string visibility: string Profile User Permission Profile User Permission: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Prompt Version Prompt
Version
: { actionButtonLabel
?: string | null ; actionButtonLink
?: string | null ; body
: string ; customApplication
?: string | null ; delayDays
: number ; description
?: string | null ; dismissButtonLabel
?: string | null ; displayPosition
?: string | null ; displayType
: string ; endDate
?: string | null ; header
?: string | null ; indexWithIsPublished
?: string | null ; indexWithoutIsPublished
?: string | null ; isPublished
?: boolean | null ; masterLabel
: string ; publishedByUser
?: string | null ; publishedDate
?: string | null ; shouldDisplayActionButton
: boolean ; startDate
: string ; targetAppDeveloperName
: string ; targetAppNamespacePrefix
?: string | null ; targetPageKey1
: string ; targetPageKey2
?: string | null ; targetPageType
: string ; timesToDisplay
: number ; title
: string ; uiFormulaRule
?: UiFormulaRule | null ; userAccess
: string ; versionNumber
: number } Type declaration Optional action Button Label?: string | null Optional action Button Link?: string | null body: string Optional custom Application?: string | null delay Days: number Optional description?: string | null Optional dismiss Button Label?: string | null Optional display Position?: string | null display Type: string Optional end Date?: string | null Optional header?: string | null Optional index With Is Published?: string | null Optional index Without Is Published?: string | null Optional is Published?: boolean | null master Label: string Optional published By User?: string | null Optional published Date?: string | null should Display Action Button: boolean start Date: string target App Developer Name: string Optional target App Namespace Prefix?: string | null target Page Key1: string Optional target Page Key2?: string | null target Page Type: string times To Display: number title: string Optional ui Formula Rule?: UiFormulaRule | null user Access: string version Number: number Public Groups Public Groups: { publicGroup: string [] }
Push Notification Push Notification: { fieldNames: string [] ; objectName: string }
Type declaration field Names: string [] object Name: string Queue Queue
: Metadata & { doesSendEmailToMembers
?: boolean | null ; email
?: string | null ; name
: string ; queueMembers
?: QueueMembers | null ; queueRoutingConfig
?: string | null ; queueSobject
: QueueSobject [] } Queue Routing Config Queue
Routing
Config
: Metadata & { capacityPercentage
?: number | null ; capacityWeight
?: number | null ; dropAdditionalSkillsTimeout
?: number | null ; isAttributeBased
?: boolean | null ; label
: string ; pushTimeout
?: number | null ; queueOverflowAssignee
?: string | null ; routingModel
: string ; routingPriority
: number ; userOverflowAssignee
?: string | null } Queue Sobject Queue Sobject: { sobjectType: string }
Quick Action Quick
Action
: Metadata & { canvas
?: string | null ; description
?: string | null ; fieldOverrides
: FieldOverride [] ; flowDefinition
?: string | null ; height
?: number | null ; icon
?: string | null ; isProtected
?: boolean | null ; label
?: string | null ; lightningComponent
?: string | null ; mobExtDisplayMode
?: string | null ; optionsCreateFeedItem
: boolean ; page
?: string | null ; quickActionLayout
?: QuickActionLayout | null ; quickActionSendEmailOptions
?: QuickActionSendEmailOptions | null ; standardLabel
?: string | null ; successMessage
?: string | null ; targetObject
?: string | null ; targetParentField
?: string | null ; targetRecordType
?: string | null ; type
: string ; width
?: number | null } Quick Action Layout Type declaration layout Section Style: string Quick Action Layout Item Quick Action Layout Item: { emptySpace?: boolean | null ; field?: string | null ; uiBehavior?: string | null }
Type declaration Optional empty Space?: boolean | null Optional field?: string | null Optional ui Behavior?: string | null Quick Action List Item Quick Action List Item: { quickActionName: string }
Quick Action Send Email Options Quick Action Send Email Options: { defaultEmailTemplateName?: string | null ; ignoreDefaultEmailTemplateSubject: boolean }
Type declaration Optional default Email Template Name?: string | null ignore Default Email Template Subject: boolean Quick Action Translation Quick Action Translation: { label: string ; name: string }
Type declaration label: string name: string Quotas Settings Quotas Settings: { showQuotas: boolean }
Quote Settings Quote
Settings
: Metadata & { enableQuote
: boolean ; enableQuotesWithoutOppEnabled
?: boolean | null } Recommendation Audience Detail Recommendation Audience Detail: { audienceCriteriaType?: string | null ; audienceCriteriaValue?: string | null ; setupName?: string | null }
Type declaration Optional audience Criteria Type?: string | null Optional audience Criteria Value?: string | null Optional setup Name?: string | null Recommendation Condition Value Recommendation Condition Value: { type: string ; value?: string | null }
Type declaration type: string Optional value?: string | null Recommendation Definition Detail Recommendation
Definition
Detail
: { actionUrl
?: string | null ; description
?: string | null ; linkText
?: string | null ; scheduledRecommendations
?: ScheduledRecommendation | null ; setupName
?: string | null ; title
?: string | null } Type declaration Optional action Url?: string | null Optional description?: string | null Optional link Text?: string | null Optional setup Name?: string | null Optional title?: string | null Recommendation Load Condition Type declaration field: string operator: string Record Action Default Item Record Action Default Item: { action: string ; isMandatory?: boolean | null ; isUiRemoveHidden?: boolean | null ; pinned: string ; position: number ; type: string }
Type declaration action: string Optional is Mandatory?: boolean | null Optional is Ui Remove Hidden?: boolean | null pinned: string position: number type: string Record Action Deployment Channel Record
Action
Deployment
Channel
: { channel
: string ; channelItems
: RecordActionDefaultItem [] ; isAutopopEnabled
?: boolean | null } Type declaration channel: string Optional is Autopop Enabled?: boolean | null Record Action Deployment Context Record Action Deployment Context: { entityName: string ; recommendationStrategy?: string | null }
Type declaration entity Name: string Optional recommendation Strategy?: string | null Record Action Recommendation Record Action Recommendation: { defaultStrategy?: string | null ; hasDescription: boolean ; hasImage: boolean ; hasRejectAction: boolean ; hasTitle: boolean ; maxDisplayRecommendations: number }
Type declaration Optional default Strategy?: string | null has Description: boolean has Image: boolean has Reject Action: boolean has Title: boolean max Display Recommendations: number Record Action Selectable Item Record Action Selectable Item: { action: string ; type: string }
Type declaration action: string type: string Record Page Settings Record
Page
Settings
: Metadata & { enableActivityRelatedList
?: boolean | null ; enableFullRecordView
?: boolean | null } Record Type Record
Type
: Metadata & { active
: boolean ; businessProcess
?: string | null ; compactLayoutAssignment
?: string | null ; description
?: string | null ; label
: string ; picklistValues
: RecordTypePicklistValue [] } Record Type Picklist Value Record
Type
Picklist
Value
: { picklist
: string ; values
: PicklistValue [] } Record Type Translation Record Type Translation: { description?: string | null ; label: string ; name: string }
Type declaration Optional description?: string | null label: string name: string Related List Related List: { hideOnDetail: boolean ; name: string }
Type declaration hide On Detail: boolean name: string Related List Item Related List Item: { customButtons: string [] ; excludeButtons: string [] ; fields: string [] ; relatedList: string ; sortField?: string | null ; sortOrder?: string | null }
Type declaration custom Buttons: string [] exclude Buttons: string [] fields: string [] related List: string Optional sort Field?: string | null Optional sort Order?: string | null Remote Site Setting Remote
Site
Setting
: Metadata & { description
?: string | null ; disableProtocolSecurity
: boolean ; isActive
: boolean ; url
: string } Report Aggregate Report Aggregate: { acrossGroupingContext?: string | null ; calculatedFormula: string ; datatype: string ; description?: string | null ; developerName: string ; downGroupingContext?: string | null ; isActive: boolean ; isCrossBlock?: boolean | null ; masterLabel: string ; reportType?: string | null ; scale?: number | null }
Type declaration Optional across Grouping Context?: string | null calculated Formula: string datatype: string Optional description?: string | null developer Name: string Optional down Grouping Context?: string | null is Active: boolean Optional is Cross Block?: boolean | null master Label: string Optional report Type?: string | null Optional scale?: number | null Report Aggregate Reference Report Aggregate Reference: { aggregate: string }
Report Block Info Type declaration block Id: string join Table: string Report Bucket Field Report
Bucket
Field
: { bucketType
: string ; developerName
: string ; masterLabel
: string ; nullTreatment
?: string | null ; otherBucketLabel
?: string | null ; sourceColumnName
: string ; useOther
?: boolean | null ; values
: ReportBucketFieldValue [] } Type declaration bucket Type: string developer Name: string master Label: string Optional null Treatment?: string | null Optional other Bucket Label?: string | null source Column Name: string Optional use Other?: boolean | null Report Bucket Field Source Value Report Bucket Field Source Value: { from?: string | null ; sourceValue?: string | null ; to?: string | null }
Type declaration Optional from?: string | null Optional source Value?: string | null Optional to?: string | null Report Chart Report
Chart
: { backgroundColor1
?: string | null ; backgroundColor2
?: string | null ; backgroundFadeDir
?: string | null ; chartSummaries
: ChartSummary [] ; chartType
: string ; enableHoverLabels
?: boolean | null ; expandOthers
?: boolean | null ; groupingColumn
?: string | null ; legendPosition
?: string | null ; location
?: string | null ; secondaryGroupingColumn
?: string | null ; showAxisLabels
?: boolean | null ; showPercentage
?: boolean | null ; showTotal
?: boolean | null ; showValues
?: boolean | null ; size
?: string | null ; summaryAxisManualRangeEnd
?: number | null ; summaryAxisManualRangeStart
?: number | null ; summaryAxisRange
?: string | null ; textColor
?: string | null ; textSize
?: number | null ; title
?: string | null ; titleColor
?: string | null ; titleSize
?: number | null } Type declaration Optional background Color1?: string | null Optional background Color2?: string | null Optional background Fade Dir?: string | null chart Type: string Optional enable Hover Labels?: boolean | null Optional expand Others?: boolean | null Optional grouping Column?: string | null Optional legend Position?: string | null Optional location?: string | null Optional secondary Grouping Column?: string | null Optional show Axis Labels?: boolean | null Optional show Percentage?: boolean | null Optional show Total?: boolean | null Optional show Values?: boolean | null Optional size?: string | null Optional summary Axis Manual Range End?: number | null Optional summary Axis Manual Range Start?: number | null Optional summary Axis Range?: string | null Optional text Color?: string | null Optional text Size?: number | null Optional title?: string | null Optional title Color?: string | null Optional title Size?: number | null Report Chart Component Layout Item Report Chart Component Layout Item: { cacheData?: boolean | null ; contextFilterableField?: string | null ; error?: string | null ; hideOnError?: boolean | null ; includeContext?: boolean | null ; reportName: string ; showTitle?: boolean | null ; size?: string | null }
Type declaration Optional cache Data?: boolean | null Optional context Filterable Field?: string | null Optional error?: string | null Optional hide On Error?: boolean | null Optional include Context?: boolean | null report Name: string Optional show Title?: boolean | null Optional size?: string | null Report Color Range Report Color Range: { aggregate?: string | null ; columnName: string ; highBreakpoint?: number | null ; highColor: string ; lowBreakpoint?: number | null ; lowColor: string ; midColor: string }
Type declaration Optional aggregate?: string | null column Name: string Optional high Breakpoint?: number | null high Color: string Optional low Breakpoint?: number | null low Color: string mid Color: string Report Column Report Column: { aggregateTypes: string [] ; field: string ; reverseColors?: boolean | null ; showChanges?: boolean | null }
Type declaration aggregate Types: string [] field: string Optional reverse Colors?: boolean | null Optional show Changes?: boolean | null Report Cross Filter Report
Cross
Filter
: { criteriaItems
: ReportFilterItem [] ; operation
: string ; primaryTableColumn
: string ; relatedTable
: string ; relatedTableJoinColumn
: string } Type declaration operation: string primary Table Column: string related Table: string related Table Join Column: string Report Custom Detail Formula Report Custom Detail Formula: { calculatedFormula: string ; dataType: string ; description?: string | null ; developerName: string ; label: string ; scale: number }
Type declaration calculated Formula: string data Type: string Optional description?: string | null developer Name: string label: string scale: number Report Data Category Filter Report Data Category Filter: { dataCategory: string ; dataCategoryGroup: string ; operator: string }
Type declaration data Category: string data Category Group: string operator: string Report Filter Report
Filter
: { booleanFilter
?: string | null ; criteriaItems
: ReportFilterItem [] ; language
?: string | null } Type declaration Optional boolean Filter?: string | null Optional language?: string | null Report Filter Item Report Filter Item: { column: string ; columnToColumn?: boolean | null ; isUnlocked?: boolean | null ; operator: string ; snapshot?: string | null ; value?: string | null }
Type declaration column: string Optional column To Column?: boolean | null Optional is Unlocked?: boolean | null operator: string Optional snapshot?: string | null Optional value?: string | null Report Formatting Rule Type declaration Optional aggregate?: string | null column Name: string Report Formatting Rule Value Report Formatting Rule Value: { backgroundColor?: string | null ; rangeUpperBound?: number | null }
Type declaration Optional background Color?: string | null Optional range Upper Bound?: number | null Report Grouping Report Grouping: { aggregateType?: string | null ; dateGranularity?: string | null ; field: string ; sortByName?: string | null ; sortOrder: string ; sortType?: string | null }
Type declaration Optional aggregate Type?: string | null Optional date Granularity?: string | null field: string Optional sort By Name?: string | null sort Order: string Optional sort Type?: string | null Report Historical Selector Report Historical Selector: { snapshot: string [] }
Report Param Report Param: { name: string ; value: string }
Type declaration name: string value: string Report Time Frame Filter Report Time Frame Filter: { dateColumn: string ; endDate?: string | null ; interval: string ; startDate?: string | null }
Type declaration date Column: string Optional end Date?: string | null interval: string Optional start Date?: string | null Report Type Report
Type
: Metadata & { autogenerated
?: boolean | null ; baseObject
: string ; category
: string ; deployed
: boolean ; description
?: string | null ; join
?: ObjectRelationship | null ; label
: string ; sections
: ReportLayoutSection [] } Report Type Column Report Type Column: { checkedByDefault: boolean ; displayNameOverride?: string | null ; field: string ; table: string }
Type declaration checked By Default: boolean Optional display Name Override?: string | null field: string table: string Report Type Column Translation Report Type Column Translation: { label: string ; name: string }
Type declaration label: string name: string Report Type Section Translation Type declaration Optional label?: string | null name: string Report Type Translation Type declaration Optional description?: string | null Optional label?: string | null name: string Reputation Branding Reputation Branding: { smallImage?: string | null }
Type declaration Optional small Image?: string | null Reputation Level Reputation
Level
: { branding
?: ReputationBranding | null ; label
?: string | null ; lowerThreshold
: number } Type declaration Optional label?: string | null lower Threshold: number Reputation Level Definitions Reputation Points Rule Reputation Points Rule: { eventType: string ; points: number }
Type declaration event Type: string points: number Restriction Rule Restriction
Rule
: Metadata & { active
: boolean ; description
: string ; enforcementType
: string ; masterLabel
: string ; recordFilter
: string ; targetEntity
: string ; userCriteria
: string ; version
: number } Retail Execution Settings Retail
Execution
Settings
: Metadata & { enableRetailExecution
?: boolean | null } Retrieve Message Retrieve Message: { fileName: string ; problem: string }
Type declaration file Name: string problem: string Retrieve Request Retrieve
Request
: { apiVersion
: number ; packageNames
: string [] ; singlePackage
: boolean ; specificFiles
: string [] ; unpackaged
?: Package | null } Type declaration api Version: number package Names: string [] single Package: boolean specific Files: string [] Optional unpackaged?: Package | null Retrieve Result Retrieve
Result
: { done
: boolean ; errorMessage
?: string | null ; errorStatusCode
?: string | null ; fileProperties
: FileProperties [] ; id
: string ; messages
: RetrieveMessage [] ; status
: string ; success
: boolean ; zipFile
: string } Type declaration done: boolean Optional error Message?: string | null Optional error Status Code?: string | null id: string status: string success: boolean zip File: string Role And Subordinates Role And Subordinates: { roleAndSubordinate: string [] }
Type declaration role And Subordinate: string [] Role And Subordinates Internal Role And Subordinates Internal: { roleAndSubordinateInternal: string [] }
Type declaration role And Subordinate Internal: string [] Role Or Territory Role
Or
Territory
: Metadata & { caseAccessLevel
?: string | null ; contactAccessLevel
?: string | null ; description
?: string | null ; mayForecastManagerShare
?: boolean | null ; name
: string ; opportunityAccessLevel
?: string | null } Roles Roles: { role: string [] }
Rule Entry Rule
Entry
: { assignedTo
?: string | null ; assignedToType
?: string | null ; booleanFilter
?: string | null ; businessHours
?: string | null ; businessHoursSource
?: string | null ; criteriaItems
: FilterItem [] ; disableEscalationWhenModified
?: boolean | null ; escalationAction
: EscalationAction [] ; escalationStartTime
?: string | null ; formula
?: string | null ; notifyCcRecipients
?: boolean | null ; overrideExistingTeams
?: boolean | null ; replyToEmail
?: string | null ; senderEmail
?: string | null ; senderName
?: string | null ; team
: string [] ; template
?: string | null } Type declaration Optional assigned To?: string | null Optional assigned To Type?: string | null Optional boolean Filter?: string | null Optional business Hours?: string | null Optional business Hours Source?: string | null Optional disable Escalation When Modified?: boolean | null Optional escalation Start Time?: string | null Optional formula?: string | null Optional notify Cc Recipients?: boolean | null Optional override Existing Teams?: boolean | null Optional reply To Email?: string | null Optional sender Email?: string | null Optional sender Name?: string | null team: string [] Optional template?: string | null Run Test Failure Run Test Failure: { id: string ; message: string ; methodName?: string | null ; name: string ; namespace?: string | null ; packageName: string ; seeAllData?: boolean | null ; stackTrace?: string | null ; time: number ; type: string }
Type declaration id: string message: string Optional method Name?: string | null name: string Optional namespace?: string | null package Name: string Optional see All Data?: boolean | null Optional stack Trace?: string | null time: number type: string Run Test Success Run Test Success: { id: string ; methodName: string ; name: string ; namespace?: string | null ; seeAllData?: boolean | null ; time: number }
Type declaration id: string method Name: string name: string Optional namespace?: string | null Optional see All Data?: boolean | null time: number Run Tests Result Type declaration Optional apex Log Id?: string | null num Failures: number num Tests Run: number total Time: number Saml Sso Config Saml
Sso
Config
: Metadata & { attributeName
?: string | null ; attributeNameIdFormat
?: string | null ; decryptionCertificate
?: string | null ; errorUrl
?: string | null ; executionUserId
?: string | null ; identityLocation
: string ; identityMapping
: string ; issuer
: string ; loginUrl
?: string | null ; logoutUrl
?: string | null ; name
: string ; oauthTokenEndpoint
?: string | null ; redirectBinding
?: boolean | null ; requestSignatureMethod
?: string | null ; requestSigningCertId
?: string | null ; salesforceLoginUrl
?: string | null ; samlEntityId
: string ; samlJitHandlerId
?: string | null ; samlVersion
: string ; singleLogoutBinding
?: string | null ; singleLogoutUrl
?: string | null ; userProvisioning
?: boolean | null ; validationCert
: string } Save Result Save
Result
: { errors
: Error [] ; fullName
: string ; success
: boolean } Type declaration full Name: string success: boolean Scheduled Recommendation Detail Scheduled Recommendation Detail: { channel?: string | null ; enabled?: boolean | null ; rank?: number | null ; recommendationAudience?: string | null }
Type declaration Optional channel?: string | null Optional enabled?: boolean | null Optional rank?: number | null Optional recommendation Audience?: string | null Schema Settings Schema
Settings
: Metadata & { enableAdvancedCMTSecurity
?: boolean | null ; enableAdvancedCSSecurity
?: boolean | null ; enableListCustomSettingCreation
?: boolean | null ; enableSOSLOnCustomSettings
?: boolean | null } Scontrol Scontrol
: MetadataWithContent & { contentSource
: string ; description
?: string | null ; encodingKey
: string ; fileContent
?: string | null ; fileName
?: string | null ; name
: string ; supportsCaching
: boolean } Scontrol Translation Scontrol Translation: { label: string ; name: string }
Type declaration label: string name: string Search Layouts Search Layouts: { customTabListAdditionalFields: string [] ; excludedStandardButtons: string [] ; listViewButtons: string [] ; lookupDialogsAdditionalFields: string [] ; lookupFilterFields: string [] ; lookupPhoneDialogsAdditionalFields: string [] ; massQuickActions: string [] ; searchFilterFields: string [] ; searchResultsAdditionalFields: string [] ; searchResultsCustomButtons: string [] }
Type declaration custom Tab List Additional Fields: string [] excluded Standard Buttons: string [] list View Buttons: string [] lookup Dialogs Additional Fields: string [] lookup Filter Fields: string [] lookup Phone Dialogs Additional Fields: string [] mass Quick Actions: string [] search Filter Fields: string [] search Results Additional Fields: string [] search Results Custom Buttons: string [] Search Settings Search
Settings
: Metadata & { documentContentSearchEnabled
: boolean ; enableAdvancedSearchInAlohaSidebar
?: boolean | null ; enableEinsteinSearchPersonalization
?: boolean | null ; enableQuerySuggestionPigOn
?: boolean | null ; enableSalesforceGeneratedSynonyms
?: boolean | null ; enableSetupSearch
?: boolean | null ; optimizeSearchForCJKEnabled
: boolean ; recentlyViewedUsersForBlankLookupEnabled
: boolean ; searchSettingsByObject
: SearchSettingsByObject ; sidebarAutoCompleteEnabled
: boolean ; sidebarDropDownListEnabled
: boolean ; sidebarLimitToItemsIOwnCheckboxEnabled
: boolean ; singleSearchResultShortcutEnabled
: boolean ; spellCorrectKnowledgeSearchEnabled
: boolean } Security Settings Security
Settings
: Metadata & { canUsersGrantLoginAccess
?: boolean | null ; enableAdminLoginAsAnyUser
?: boolean | null ; enableAuditFieldsInactiveOwner
?: boolean | null ; enableAuraSecureEvalPref
?: boolean | null ; enableRequireHttpsConnection
?: boolean | null ; isTLSv12Required
?: boolean | null ; isTLSv12RequiredCommunities
?: boolean | null ; networkAccess
?: NetworkAccess | null ; passwordPolicies
?: PasswordPolicies | null ; sessionSettings
?: SessionSettings | null ; singleSignOnSettings
?: SingleSignOnSettings | null } Service Channel Service
Channel
: Metadata & { interactionComponent
?: string | null ; label
: string ; relatedEntityType
: string ; secondaryRoutingPriorityField
?: string | null ; serviceChannelFieldPriorities
: ServiceChannelFieldPriority [] } Service Channel Field Priority Service Channel Field Priority: { priority: number ; value: string }
Type declaration priority: number value: string Service Channel Status Service Channel Status: { channel: string [] }
Service Cloud Console Config Type declaration detail Page Refresh Method: string Optional footer Color?: string | null Optional header Color?: string | null list Refresh Method: string Optional live Agent Config?: LiveAgentConfig | null Optional primary Tab Color?: string | null Optional tab Limit Config?: TabLimitConfig | null whitelisted Domains: string [] Session Settings Session Settings: { allowUserAuthenticationByCertificate?: boolean | null ; canConfirmEmailChangeInLightningCommunities?: boolean | null ; disableTimeoutWarning?: boolean | null ; enableCSPOnEmail?: boolean | null ; enableCSRFOnGet?: boolean | null ; enableCSRFOnPost?: boolean | null ; enableCacheAndAutocomplete?: boolean | null ; enableClickjackNonsetupSFDC?: boolean | null ; enableClickjackNonsetupUser?: boolean | null ; enableClickjackNonsetupUserHeaderless?: boolean | null ; enableClickjackSetup?: boolean | null ; enableContentSniffingProtection?: boolean | null ; enableLightningLogin?: boolean | null ; enableLightningLoginOnlyWithUserPerm?: boolean | null ; enablePostForSessions?: boolean | null ; enableSMSIdentity?: boolean | null ; enableU2F?: boolean | null ; enableUpgradeInsecureRequests?: boolean | null ; enableXssProtection?: boolean | null ; enforceIpRangesEveryRequest?: boolean | null ; forceLogoutOnSessionTimeout?: boolean | null ; forceRelogin?: boolean | null ; hasRetainedLoginHints?: boolean | null ; hasUserSwitching?: boolean | null ; hstsOnForcecomSites?: boolean | null ; identityConfirmationOnEmailChange?: boolean | null ; identityConfirmationOnTwoFactorRegistrationEnabled?: boolean | null ; lockSessionsToDomain?: boolean | null ; lockSessionsToIp?: boolean | null ; lockerServiceAPIVersion?: string | null ; lockerServiceCSP?: boolean | null ; lockerServiceFrozenRealm?: boolean | null ; logoutURL?: string | null ; redirectionWarning?: boolean | null ; referrerPolicy?: boolean | null ; requireHttpOnly?: boolean | null ; requireHttps?: boolean | null ; securityCentralKillSession?: boolean | null ; sessionTimeout?: string | null }
Type declaration Optional allow User Authentication By Certificate?: boolean | null Optional can Confirm Email Change In Lightning Communities?: boolean | null Optional disable Timeout Warning?: boolean | null Optional enableCSPOn Email?: boolean | null Optional enableCSRFOn Get?: boolean | null Optional enableCSRFOn Post?: boolean | null Optional enable Cache And Autocomplete?: boolean | null Optional enable Clickjack NonsetupSFDC?: boolean | null Optional enable Clickjack Nonsetup User?: boolean | null Optional enable Clickjack Nonsetup User Headerless?: boolean | null Optional enable Clickjack Setup?: boolean | null Optional enable Content Sniffing Protection?: boolean | null Optional enable Lightning Login?: boolean | null Optional enable Lightning Login Only With User Perm?: boolean | null Optional enable Post For Sessions?: boolean | null Optional enableSMSIdentity?: boolean | null Optional enable U2F?: boolean | null Optional enable Upgrade Insecure Requests?: boolean | null Optional enable Xss Protection?: boolean | null Optional enforce Ip Ranges Every Request?: boolean | null Optional force Logout On Session Timeout?: boolean | null Optional force Relogin?: boolean | null Optional has Retained Login Hints?: boolean | null Optional has User Switching?: boolean | null Optional hsts On Forcecom Sites?: boolean | null Optional identity Confirmation On Email Change?: boolean | null Optional identity Confirmation On Two Factor Registration Enabled?: boolean | null Optional lock Sessions To Domain?: boolean | null Optional lock Sessions To Ip?: boolean | null Optional locker ServiceAPIVersion?: string | null Optional locker ServiceCSP?: boolean | null Optional locker Service Frozen Realm?: boolean | null Optional logoutURL?: string | null Optional redirection Warning?: boolean | null Optional referrer Policy?: boolean | null Optional require Http Only?: boolean | null Optional require Https?: boolean | null Optional security Central Kill Session?: boolean | null Optional session Timeout?: string | null Shared To Shared To: { allCustomerPortalUsers?: string | null ; allInternalUsers?: string | null ; allPartnerUsers?: string | null ; channelProgramGroup: string [] ; channelProgramGroups: string [] ; group: string [] ; groups: string [] ; guestUser: string [] ; managerSubordinates: string [] ; managers: string [] ; portalRole: string [] ; portalRoleAndSubordinates: string [] ; queue: string [] ; role: string [] ; roleAndSubordinates: string [] ; roleAndSubordinatesInternal: string [] ; roles: string [] ; rolesAndSubordinates: string [] ; territories: string [] ; territoriesAndSubordinates: string [] ; territory: string [] ; territoryAndSubordinates: string [] }
Type declaration Optional all Customer Portal Users?: string | null Optional all Internal Users?: string | null Optional all Partner Users?: string | null channel Program Group: string [] channel Program Groups: string [] group: string [] groups: string [] guest User: string [] manager Subordinates: string [] managers: string [] portal Role: string [] portal Role And Subordinates: string [] queue: string [] role: string [] role And Subordinates: string [] role And Subordinates Internal: string [] roles: string [] roles And Subordinates: string [] territories: string [] territories And Subordinates: string [] territory: string [] territory And Subordinates: string [] Sharing Reason Sharing
Reason
: Metadata & { label
: string } Sharing Reason Translation Sharing Reason Translation: { label: string ; name: string }
Type declaration label: string name: string Sharing Recalculation Sharing Recalculation: { className: string }
Sharing Set Sharing
Set
: Metadata & { accessMappings
: AccessMapping [] ; description
?: string | null ; name
: string ; profiles
: string [] } Sharing Settings Sharing
Settings
: Metadata & { enableAccountRoleOptimization
?: boolean | null ; enableAssetSharing
?: boolean | null ; enableCommunityUserVisibility
?: boolean | null ; enableExternalSharingModel
?: boolean | null ; enableManagerGroups
?: boolean | null ; enableManualUserRecordSharing
?: boolean | null ; enablePartnerSuperUserAccess
?: boolean | null ; enablePortalUserCaseSharing
?: boolean | null ; enablePortalUserVisibility
?: boolean | null ; enableRemoveTMGroupMembership
?: boolean | null ; enableSecureGuestAccess
?: boolean | null ; enableStandardReportVisibility
?: boolean | null ; enableTerritoryForecastManager
?: boolean | null } Sidebar Component Sidebar
Component
: { componentType
: string ; createAction
?: string | null ; enableLinking
?: boolean | null ; height
?: number | null ; label
?: string | null ; lookup
?: string | null ; page
?: string | null ; relatedLists
: RelatedList [] ; unit
?: string | null ; updateAction
?: string | null ; width
?: number | null } Type declaration component Type: string Optional create Action?: string | null Optional enable Linking?: boolean | null Optional height?: number | null Optional label?: string | null Optional lookup?: string | null Optional page?: string | null Optional unit?: string | null Optional update Action?: string | null Optional width?: number | null Single Sign On Settings Single Sign On Settings: { enableForceDelegatedCallout?: boolean | null ; enableMultipleSamlConfigs?: boolean | null ; enableSamlJitProvisioning?: boolean | null ; enableSamlLogin?: boolean | null }
Type declaration Optional enable Force Delegated Callout?: boolean | null Optional enable Multiple Saml Configs?: boolean | null Optional enable Saml Jit Provisioning?: boolean | null Optional enable Saml Login?: boolean | null Site Redirect Mapping Site Redirect Mapping: { action: string ; isActive?: boolean | null ; source: string ; target: string }
Type declaration action: string Optional is Active?: boolean | null source: string target: string Site Settings Site
Settings
: Metadata & { enableProxyLoginICHeader
?: boolean | null ; enableTopicsInSites
?: boolean | null ; enableVisualforceApiAccessAllowed
?: boolean | null } Site Web Address Site Web Address: { certificate?: string | null ; domainName: string ; primary: boolean }
Type declaration Optional certificate?: string | null domain Name: string primary: boolean Skill Profile Assignments Skill Profile Assignments: { profile: string [] }
Skill User Assignments Skill User Assignments: { user: string [] }
Social Customer Service Settings Social
Customer
Service
Settings
: Metadata & { caseSubjectOption
: string ; enableSocialApprovals
?: boolean | null ; enableSocialCaseAssignmentRules
?: boolean | null ; enableSocialCustomerService
?: boolean | null ; enableSocialPersonaHistoryTracking
?: boolean | null ; enableSocialPostHistoryTracking
?: boolean | null ; enableSocialReceiveParentPost
?: boolean | null } Social Profile Settings Social
Profile
Settings
: Metadata & { enableSocialProfiles
?: boolean | null ; isFacebookSocialProfilesDisabled
?: boolean | null ; isLinkedInSocialProfilesDisabled
?: boolean | null ; isTwitterSocialProfilesDisabled
?: boolean | null ; isYouTubeSocialProfilesDisabled
?: boolean | null } Source Tracking Settings Source
Tracking
Settings
: Metadata & { enableSourceTrackingSandboxes
?: boolean | null } Standard Field Translation Standard Field Translation: { label?: string | null ; name: string }
Type declaration Optional label?: string | null name: string Standard Value Standard
Value
: CustomValue & { allowEmail
?: boolean | null ; closed
?: boolean | null ; converted
?: boolean | null ; cssExposed
?: boolean | null ; forecastCategory
?: string | null ; groupingString
?: string | null ; highPriority
?: boolean | null ; probability
?: number | null ; reverseRole
?: string | null ; reviewed
?: boolean | null ; won
?: boolean | null } Standard Value Set Standard
Value
Set
: Metadata & { groupingStringEnum
?: string | null ; sorted
: boolean ; standardValue
: StandardValue [] } Standard Value Set Translation State State: { active: boolean ; integrationValue: string ; isoCode: string ; label: string ; standard: boolean ; visible: boolean }
Type declaration active: boolean integration Value: string iso Code: string label: string standard: boolean visible: boolean Static Resource Static
Resource
: MetadataWithContent & { cacheControl
: string ; contentType
: string ; description
?: string | null } Strategy Action Strategy
Action
: { action
: string ; argument
: StrategyActionArg [] ; description
?: string | null ; label
?: string | null ; name
: string ; type
: string } Type declaration action: string Optional description?: string | null Optional label?: string | null name: string type: string Strategy Action Arg Strategy Action Arg: { name: string ; value: string }
Type declaration name: string value: string Strategy Node Base Strategy Node Base: { childNode: string [] ; description?: string | null ; label?: string | null ; name: string }
Type declaration child Node: string [] Optional description?: string | null Optional label?: string | null name: string Strategy Node Invocable Action Strategy Node Invocable Action Arg Strategy Node Invocable Action Arg: { name: string ; value: string }
Type declaration name: string value: string Strategy Node Recommendation Limit Strategy
Node
Recommendation
Limit
: StrategyNodeUnionBase & { filterMode
: string [] ; lookbackDuration
?: number | null ; maxRecommendationCount
?: number | null } Strategy Node Recommendation Load Strategy Node Sort Field Strategy Node Sort Field: { name: string ; nullsFirst?: boolean | null ; order?: string | null }
Type declaration name: string Optional nulls First?: boolean | null Optional order?: string | null Subtab Components Subtab
Components
: { containers
: Container [] } Summary Layout Summary
Layout
: { masterLabel
: string ; sizeX
: number ; sizeY
?: number | null ; sizeZ
?: number | null ; summaryLayoutItems
: SummaryLayoutItem [] ; summaryLayoutStyle
: string } Type declaration master Label: string sizeX: number Optional sizeY?: number | null Optional sizeZ?: number | null summary Layout Style: string Summary Layout Item Summary Layout Item: { customLink?: string | null ; field?: string | null ; posX: number ; posY?: number | null ; posZ?: number | null }
Type declaration Optional custom Link?: string | null Optional field?: string | null posX: number Optional posY?: number | null Optional posZ?: number | null Supervisor Agent Config Skills Supervisor Agent Config Skills: { skill: string [] }
Survey Settings Survey
Settings
: Metadata & { enableSurvey
?: boolean | null ; enableSurveyOwnerCanManageResponse
?: boolean | null } Synonym Dictionary Synonym
Dictionary
: Metadata & { groups
: SynonymGroup [] ; isProtected
?: boolean | null ; label
: string } Synonym Group Synonym Group: { languages: string [] ; terms: string [] }
Type declaration languages: string [] terms: string [] System Notification Settings System
Notification
Settings
: Metadata & { disableDowntimeNotifications
?: boolean | null ; disableMaintenanceNotifications
?: boolean | null } Tab Limit Config Tab Limit Config: { maxNumberOfPrimaryTabs?: string | null ; maxNumberOfSubTabs?: string | null }
Type declaration Optional max Number Of Primary Tabs?: string | null Optional max Number Of Sub Tabs?: string | null Targets Targets: { target: string [] }
Territory Territory
: RoleOrTerritory & { accountAccessLevel
?: string | null ; parentTerritory
?: string | null } Territory2 Territory2
: Metadata & { accountAccessLevel
?: string | null ; caseAccessLevel
?: string | null ; contactAccessLevel
?: string | null ; customFields
: FieldValue [] ; description
?: string | null ; name
: string ; opportunityAccessLevel
?: string | null ; parentTerritory
?: string | null ; ruleAssociations
: Territory2RuleAssociation [] ; territory2Type
: string } Territory2 Model Territory2
Model
: Metadata & { customFields
: FieldValue [] ; description
?: string | null ; name
: string } Territory2 Rule Territory2
Rule
: Metadata & { active
: boolean ; booleanFilter
?: string | null ; name
: string ; objectType
: string ; ruleItems
: Territory2RuleItem [] } Territory2 Rule Association Territory2 Rule Association: { inherited: boolean ; ruleName: string }
Type declaration inherited: boolean rule Name: string Territory2 Rule Item Territory2 Rule Item: { field: string ; operation: string ; value?: string | null }
Type declaration field: string operation: string Optional value?: string | null Territory2 Settings Territory2
Settings
: Metadata & { defaultAccountAccessLevel
?: string | null ; defaultCaseAccessLevel
?: string | null ; defaultContactAccessLevel
?: string | null ; defaultOpportunityAccessLevel
?: string | null ; enableTerritoryManagement2
?: boolean | null ; opportunityFilterSettings
?: Territory2SettingsOpportunityFilter | null } Territory2 Settings Opportunity Filter Territory2 Settings Opportunity Filter: { apexClassName?: string | null ; enableFilter: boolean ; runOnCreate: boolean }
Type declaration Optional apex Class Name?: string | null enable Filter: boolean run On Create: boolean Territory2 Type Territory2
Type
: Metadata & { description
?: string | null ; name
: string ; priority
: number } Time Sheet Template Time
Sheet
Template
: Metadata & { active
: boolean ; description
?: string | null ; frequency
: string ; masterLabel
: string ; startDate
: string ; timeSheetTemplateAssignments
: TimeSheetTemplateAssignment [] ; workWeekEndDay
: string ; workWeekStartDay
: string } Time Sheet Template Assignment Time Sheet Template Assignment: { assignedTo?: string | null }
Type declaration Optional assigned To?: string | null Topics For Objects Topics
For
Objects
: Metadata & { enableTopics
: boolean ; entityApiName
: string } Trailhead Settings Trailhead
Settings
: Metadata & { enableMyTrailheadPref
?: boolean | null } Transaction Security Action Transaction
Security
Action
: { block
: boolean ; endSession
: boolean ; freezeUser
: boolean ; notifications
: TransactionSecurityNotification [] ; twoFactorAuthentication
: boolean } Type declaration block: boolean end Session: boolean freeze User: boolean two Factor Authentication: boolean Transaction Security Notification Transaction Security Notification: { inApp: boolean ; sendEmail: boolean ; user: string }
Type declaration in App: boolean send Email: boolean user: string Transaction Security Policy Transaction
Security
Policy
: Metadata & { action
: TransactionSecurityAction ; active
: boolean ; apexClass
?: string | null ; description
?: string | null ; developerName
?: string | null ; eventName
?: string | null ; eventType
?: string | null ; executionUser
?: string | null ; flow
?: string | null ; masterLabel
?: string | null ; resourceName
?: string | null ; type
?: string | null } UIObject Relation Config UIObject
Relation
Config
: Metadata & { UIObjectRelationFieldConfigs
: UIObjectRelationFieldConfig [] ; contextObject
: string ; contextObjectRecordType
?: string | null ; directRelationshipField
?: string | null ; indirectObjectContextField
?: string | null ; indirectObjectRelatedField
?: string | null ; indirectRelationshipObject
?: string | null ; isActive
: boolean ; masterLabel
: string ; relatedObject
: string ; relatedObjectRecordType
?: string | null ; relationshipType
: string } UIObject Relation Field Config UIObject Relation Field Config: { displayLabel: string ; queryText: string ; rowOrder: number }
Type declaration display Label: string query Text: string row Order: number Ui Formula Criterion Ui Formula Criterion: { leftValue: string ; operator: string ; rightValue?: string | null }
Type declaration left Value: string operator: string Optional right Value?: string | null Ui Formula Rule Type declaration Optional boolean Filter?: string | null Ui Plugin Ui
Plugin
: MetadataWithContent & { description
?: string | null ; extensionPointIdentifier
: string ; isEnabled
: boolean ; language
: string ; masterLabel
: string } Upsert Result Upsert
Result
: { created
: boolean ; errors
: Error [] ; fullName
: string ; success
: boolean } Type declaration created: boolean full Name: string success: boolean User Criteria User
Criteria
: Metadata & { creationAgeInSeconds
?: number | null ; description
?: string | null ; lastChatterActivityAgeInSeconds
?: number | null ; masterLabel
: string ; profiles
: string [] ; userTypes
: string [] } User Engagement Settings User
Engagement
Settings
: Metadata & { canGovCloudUseAdoptionApps
?: boolean | null ; doesScheduledSwitcherRunDaily
?: boolean | null ; enableCustomHelpGlobalSection
?: boolean | null ; enableHelpMenuShowFeedback
?: boolean | null ; enableHelpMenuShowHelp
?: boolean | null ; enableHelpMenuShowNewUser
?: boolean | null ; enableHelpMenuShowSearch
?: boolean | null ; enableHelpMenuShowSfdcContent
?: boolean | null ; enableHelpMenuShowShortcut
?: boolean | null ; enableHelpMenuShowSupport
?: boolean | null ; enableHelpMenuShowTrailhead
?: boolean | null ; enableIBILOptOutDashboards
?: boolean | null ; enableIBILOptOutEvents
?: boolean | null ; enableIBILOptOutReports
?: boolean | null ; enableIBILOptOutTasks
?: boolean | null ; enableLexToClassicFeedbackEnable
?: boolean | null ; enableOrchestrationInSandbox
?: boolean | null ; enableOrgUserAssistEnabled
?: boolean | null ; enableScheduledSwitcher
?: boolean | null ; enableSfdcProductFeedbackSurvey
?: boolean | null ; enableShowSalesforceUserAssist
?: boolean | null ; isAutoTransitionDelayed
?: boolean | null ; isCrucNotificationDisabled
?: boolean | null ; isCustomProfileAutoTransitionDelayed
?: boolean | null ; isLEXWelcomeMatDisabled
?: boolean | null ; isMeetTheAssistantDisabledInClassic
?: boolean | null ; isMeetTheAssistantDisabledInLightning
?: boolean | null ; optimizerAppEnabled
?: boolean | null } User Interface Settings User
Interface
Settings
: Metadata & { alternateAlohaListView
?: boolean | null ; enableAsyncRelatedLists
?: boolean | null ; enableClickjackUserPageHeaderless
?: boolean | null ; enableCollapsibleSections
?: boolean | null ; enableCollapsibleSideBar
?: boolean | null ; enableCustomObjectTruncate
?: boolean | null ; enableCustomeSideBarOnAllPages
?: boolean | null ; enableDeleteFieldHistory
?: boolean | null ; enableHoverDetails
?: boolean | null ; enableInlineEdit
?: boolean | null ; enableNewPageLayoutEditor
?: boolean | null ; enablePersonalCanvas
?: boolean | null ; enablePrintableListViews
?: boolean | null ; enableProfileCustomTabsets
?: boolean | null ; enableQuickCreate
?: boolean | null ; enableTabOrganizer
?: boolean | null } User Management Settings User
Management
Settings
: Metadata & { enableCanAnswerContainUsername
?: boolean | null ; enableCanSaveUserPerm
?: boolean | null ; enableConcealPersonalInfo
?: boolean | null ; enableContactlessExternalIdentityUsers
?: boolean | null ; enableEnhancedPermsetMgmt
?: boolean | null ; enableEnhancedProfileMgmt
?: boolean | null ; enableNewProfileUI
?: boolean | null ; enableScrambleUserData
?: boolean | null ; enableUserSelfDeactivate
?: boolean | null } Users Users: { user: string [] }
Validation Rule Validation
Rule
: Metadata & { active
: boolean ; description
?: string | null ; errorConditionFormula
: string ; errorDisplayField
?: string | null ; errorMessage
: string } Validation Rule Translation Validation Rule Translation: { errorMessage: string ; name: string }
Type declaration error Message: string name: string Value Set Value
Set
: { controllingField
?: string | null ; restricted
?: boolean | null ; valueSetDefinition
?: ValueSetValuesDefinition | null ; valueSetName
?: string | null ; valueSettings
: ValueSettings [] } Type declaration Optional controlling Field?: string | null Optional restricted?: boolean | null Optional value Set Name?: string | null Value Set Values Definition Value
Set
Values
Definition
: { sorted
: boolean ; value
: CustomValue [] } Value Settings Value Settings: { controllingFieldValue: string [] ; valueName: string }
Type declaration controlling Field Value: string [] value Name: string Value Translation Value Translation: { masterLabel: string ; translation?: string | null }
Type declaration master Label: string Optional translation?: string | null Value Type Field Value
Type
Field
: { fields
: ValueTypeField [] ; foreignKeyDomain
: string [] ; isForeignKey
: boolean ; isNameField
: boolean ; minOccurs
: number ; name
: string ; picklistValues
: PicklistEntry [] ; soapType
: string ; valueRequired
: boolean } Type declaration foreign Key Domain: string [] is Foreign Key: boolean is Name Field: boolean min Occurs: number name: string soap Type: string value Required: boolean Voice Settings Voice
Settings
: Metadata & { enableCallDisposition
?: boolean | null ; enableVoiceCallList
?: boolean | null ; enableVoiceCallRecording
?: boolean | null ; enableVoiceCoaching
?: boolean | null ; enableVoiceConferencing
?: boolean | null ; enableVoiceLocalPresence
?: boolean | null ; enableVoiceMail
?: boolean | null ; enableVoiceMailDrop
?: boolean | null } Wave Application Wave
Application
: Metadata & { assetIcon
?: string | null ; description
?: string | null ; folder
: string ; masterLabel
: string ; shares
: FolderShare [] ; templateOrigin
?: string | null ; templateVersion
?: string | null } Wave Dashboard Wave
Dashboard
: MetadataWithContent & { application
: string ; description
?: string | null ; masterLabel
: string ; templateAssetSourceName
?: string | null } Wave Dataflow Wave
Dataflow
: MetadataWithContent & { dataflowType
?: string | null ; description
?: string | null ; masterLabel
: string } Wave Dataset Wave
Dataset
: Metadata & { application
: string ; description
?: string | null ; masterLabel
: string ; templateAssetSourceName
?: string | null } Wave Lens Wave
Lens
: MetadataWithContent & { application
: string ; datasets
: string [] ; description
?: string | null ; masterLabel
: string ; templateAssetSourceName
?: string | null ; visualizationType
: string } Wave Recipe Wave
Recipe
: MetadataWithContent & { dataflow
: string ; masterLabel
: string ; securityPredicate
?: string | null ; targetDatasetAlias
: string } Wave Template Bundle Wave
Template
Bundle
: Metadata & { assetIcon
?: string | null ; assetVersion
?: number | null ; description
?: string | null ; label
: string ; templateType
: string } Wave Xmd Wave
Xmd
: Metadata & { application
?: string | null ; dataset
: string ; datasetConnector
?: string | null ; datasetFullyQualifiedName
?: string | null ; dates
: WaveXmdDate [] ; dimensions
: WaveXmdDimension [] ; measures
: WaveXmdMeasure [] ; organizations
: WaveXmdOrganization [] ; origin
?: string | null ; type
?: string | null ; waveVisualization
?: string | null } Wave Xmd Date Wave Xmd Date: { alias: string ; compact?: boolean | null ; dateFieldDay?: string | null ; dateFieldEpochDay?: string | null ; dateFieldEpochSecond?: string | null ; dateFieldFiscalMonth?: string | null ; dateFieldFiscalQuarter?: string | null ; dateFieldFiscalWeek?: string | null ; dateFieldFiscalYear?: string | null ; dateFieldFullYear?: string | null ; dateFieldHour?: string | null ; dateFieldMinute?: string | null ; dateFieldMonth?: string | null ; dateFieldQuarter?: string | null ; dateFieldSecond?: string | null ; dateFieldWeek?: string | null ; dateFieldYear?: string | null ; description?: string | null ; firstDayOfWeek: number ; fiscalMonthOffset: number ; isYearEndFiscalYear?: boolean | null ; label?: string | null ; showInExplorer?: boolean | null ; sortIndex: number ; type: string }
Type declaration alias: string Optional compact?: boolean | null Optional date Field Day?: string | null Optional date Field Epoch Day?: string | null Optional date Field Epoch Second?: string | null Optional date Field Fiscal Month?: string | null Optional date Field Fiscal Quarter?: string | null Optional date Field Fiscal Week?: string | null Optional date Field Fiscal Year?: string | null Optional date Field Full Year?: string | null Optional date Field Hour?: string | null Optional date Field Minute?: string | null Optional date Field Month?: string | null Optional date Field Quarter?: string | null Optional date Field Second?: string | null Optional date Field Week?: string | null Optional date Field Year?: string | null Optional description?: string | null first Day Of Week: number fiscal Month Offset: number Optional is Year End Fiscal Year?: boolean | null Optional label?: string | null Optional show In Explorer?: boolean | null sort Index: number type: string Wave Xmd Dimension Wave
Xmd
Dimension
: { conditionalFormatting
: WaveXmdFormattingProperty [] ; customActions
: WaveXmdDimensionCustomAction [] ; customActionsEnabled
?: boolean | null ; dateFormat
?: string | null ; description
?: string | null ; field
: string ; fullyQualifiedName
?: string | null ; imageTemplate
?: string | null ; isDerived
: boolean ; isMultiValue
?: boolean | null ; label
?: string | null ; linkTemplate
?: string | null ; linkTemplateEnabled
?: boolean | null ; linkTooltip
?: string | null ; members
: WaveXmdDimensionMember [] ; origin
?: string | null ; recordDisplayFields
: WaveXmdRecordDisplayLookup [] ; recordIdField
?: string | null ; recordOrganizationIdField
?: string | null ; salesforceActions
: WaveXmdDimensionSalesforceAction [] ; salesforceActionsEnabled
?: boolean | null ; showDetailsDefaultFieldIndex
?: number | null ; showInExplorer
?: boolean | null ; sortIndex
: number } Type declaration Optional custom Actions Enabled?: boolean | null Optional date Format?: string | null Optional description?: string | null field: string Optional fully Qualified Name?: string | null Optional image Template?: string | null is Derived: boolean Optional is Multi Value?: boolean | null Optional label?: string | null Optional link Template?: string | null Optional link Template Enabled?: boolean | null Optional link Tooltip?: string | null Optional origin?: string | null Optional record Id Field?: string | null Optional record Organization Id Field?: string | null Optional salesforce Actions Enabled?: boolean | null Optional show Details Default Field Index?: number | null Optional show In Explorer?: boolean | null sort Index: number Wave Xmd Dimension Custom Action Wave Xmd Dimension Custom Action: { customActionName: string ; enabled: boolean ; icon?: string | null ; method?: string | null ; sortIndex: number ; target?: string | null ; tooltip?: string | null ; url?: string | null }
Type declaration custom Action Name: string enabled: boolean Optional icon?: string | null Optional method?: string | null sort Index: number Optional target?: string | null Optional tooltip?: string | null Optional url?: string | null Wave Xmd Dimension Member Wave Xmd Dimension Member: { color?: string | null ; label?: string | null ; member: string ; sortIndex: number }
Type declaration Optional color?: string | null Optional label?: string | null member: string sort Index: number Wave Xmd Dimension Salesforce Action Wave Xmd Dimension Salesforce Action: { enabled: boolean ; salesforceActionName: string ; sortIndex: number }
Type declaration enabled: boolean salesforce Action Name: string sort Index: number Wave Xmd Formatting Bin Wave Xmd Formatting Bin: { bin: string ; formatValue: string ; label: string ; sortIndex: number }
Type declaration bin: string format Value: string label: string sort Index: number Wave Xmd Formatting Predicate Wave Xmd Formatting Predicate: { formatValue: string ; operator: string ; sortIndex: number ; value: string }
Type declaration format Value: string operator: string sort Index: number value: string Wave Xmd Formatting Property Type declaration property: string reference Field: string sort Index: number type: string Wave Xmd Measure Wave
Xmd
Measure
: { conditionalFormatting
: WaveXmdFormattingProperty [] ; dateFormat
?: string | null ; description
?: string | null ; field
: string ; formatCustomFormat
?: string | null ; formatDecimalDigits
?: number | null ; formatIsNegativeParens
?: boolean | null ; formatPrefix
?: string | null ; formatSuffix
?: string | null ; formatUnit
?: string | null ; formatUnitMultiplier
?: number | null ; fullyQualifiedName
?: string | null ; isDerived
: boolean ; label
?: string | null ; origin
?: string | null ; showDetailsDefaultFieldIndex
?: number | null ; showInExplorer
?: boolean | null ; sortIndex
: number } Type declaration Optional date Format?: string | null Optional description?: string | null field: string Optional format Custom Format?: string | null Optional format Decimal Digits?: number | null Optional format Is Negative Parens?: boolean | null Optional format Prefix?: string | null Optional format Suffix?: string | null Optional format Unit?: string | null Optional format Unit Multiplier?: number | null Optional fully Qualified Name?: string | null is Derived: boolean Optional label?: string | null Optional origin?: string | null Optional show Details Default Field Index?: number | null Optional show In Explorer?: boolean | null sort Index: number Wave Xmd Organization Wave Xmd Organization: { instanceUrl: string ; label: string ; organizationIdentifier: string ; sortIndex: number }
Type declaration instance Url: string label: string organization Identifier: string sort Index: number Wave Xmd Record Display Lookup Wave Xmd Record Display Lookup: { recordDisplayField: string }
Type declaration record Display Field: string Web Link Web
Link
: Metadata & { availability
: string ; description
?: string | null ; displayType
: string ; encodingKey
?: string | null ; hasMenubar
?: boolean | null ; hasScrollbars
?: boolean | null ; hasToolbar
?: boolean | null ; height
?: number | null ; isResizable
?: boolean | null ; linkType
: string ; masterLabel
?: string | null ; openType
: string ; page
?: string | null ; position
?: string | null ; protected
: boolean ; requireRowSelection
?: boolean | null ; scontrol
?: string | null ; showsLocation
?: boolean | null ; showsStatus
?: boolean | null ; url
?: string | null ; width
?: number | null } Web Link Translation Web Link Translation: { label: string ; name: string }
Type declaration label: string name: string Web To Case Settings Web To Case Settings: { caseOrigin?: string | null ; defaultResponseTemplate?: string | null ; enableWebToCase?: boolean | null }
Type declaration Optional case Origin?: string | null Optional default Response Template?: string | null Optional enable Web To Case?: boolean | null Weighted Source Category Weighted Source Category: { sourceCategoryApiName: string ; weight: number }
Type declaration source Category Api Name: string weight: number Work Dot Com Settings Work
Dot
Com
Settings
: Metadata & { enableCoachingManagerGroupAccess
?: boolean | null ; enableGoalManagerGroupAccess
?: boolean | null ; enableProfileSkills
?: boolean | null ; enableProfileSkillsAddFeedPost
?: boolean | null ; enableProfileSkillsAutoSuggest
?: boolean | null ; enableProfileSkillsUsePlatform
?: boolean | null ; enableWorkBadgeDefRestrictPref
?: boolean | null ; enableWorkCalibration
?: boolean | null ; enableWorkCanvasPref
?: boolean | null ; enableWorkCertification
?: boolean | null ; enableWorkCertificationNotification
?: boolean | null ; enableWorkRewardsPref
?: boolean | null ; enableWorkThanksPref
?: boolean | null ; enableWorkUseObjectivesForGoals
?: boolean | null } Workflow Action Reference Workflow Action Reference: { name: string ; type: string }
Workflow Alert Workflow
Alert
: WorkflowAction & { ccEmails
: string [] ; description
: string ; protected
: boolean ; recipients
: WorkflowEmailRecipient [] ; senderAddress
?: string | null ; senderType
?: string | null ; template
: string } Workflow Email Recipient Workflow Email Recipient: { field?: string | null ; recipient?: string | null ; type: string }
Type declaration Optional field?: string | null Optional recipient?: string | null type: string Workflow Field Update Workflow
Field
Update
: WorkflowAction & { description
?: string | null ; field
: string ; formula
?: string | null ; literalValue
?: string | null ; lookupValue
?: string | null ; lookupValueType
?: string | null ; name
: string ; notifyAssignee
: boolean ; operation
: string ; protected
: boolean ; reevaluateOnChange
?: boolean | null ; targetObject
?: string | null } Workflow Flow Action Parameter Workflow Flow Action Parameter: { name: string ; value?: string | null }
Type declaration name: string Optional value?: string | null Workflow Knowledge Publish Workflow
Knowledge
Publish
: WorkflowAction & { action
: string ; description
?: string | null ; label
: string ; language
?: string | null ; protected
: boolean } Workflow Outbound Message Workflow
Outbound
Message
: WorkflowAction & { apiVersion
: number ; description
?: string | null ; endpointUrl
: string ; fields
: string [] ; includeSessionId
: boolean ; integrationUser
: string ; name
: string ; protected
: boolean ; useDeadLetterQueue
?: boolean | null } Workflow Send Workflow
Send
: WorkflowAction & { action
: string ; description
?: string | null ; label
: string ; language
?: string | null ; protected
: boolean } Workflow Task Workflow
Task
: WorkflowAction & { assignedTo
?: string | null ; assignedToType
: string ; description
?: string | null ; dueDateOffset
: number ; notifyAssignee
: boolean ; offsetFromField
?: string | null ; priority
: string ; protected
: boolean ; status
: string ; subject
: string } Workflow Task Translation Workflow Task Translation: { description?: string | null ; name: string ; subject?: string | null }
Type declaration Optional description?: string | null name: string Optional subject?: string | null Workflow Time Trigger Workflow
Time
Trigger
: { actions
: WorkflowActionReference [] ; offsetFromField
?: string | null ; timeLength
?: string | null ; workflowTimeTriggerUnit
: string } Type declaration Optional offset From Field?: string | null Optional time Length?: string | null workflow Time Trigger Unit: string Workspace Mapping Workspace Mapping: { fieldName?: string | null ; tab: string }
Type declaration Optional field Name?: string | null tab: string
This file is generated from WSDL file by wsdl2schema.ts. Do not modify directly. To generate the file, run "ts-node path/to/wsdl2schema.ts path/to/wsdl.xml path/to/schema.ts"